ControlSystemSetErrorLogFile: различия между версиями

Материал из CAMaaS preliminary wiki
Перейти к навигации Перейти к поиску
(Точки входа в control.dll давно уже имеют другие имена)
(Точки входа в control.dll давно уже имеют другие имена)
Строка 1: Строка 1:
{{NavBar|{{Системная иерархия:Подсистема управления}} \ SetErrorLogFile}}
{{NavBar|{{Системная иерархия:Подсистема управления}} \ ControlSystemSetErrorLogFile}}


{{function begin|std::uint32_t SetErrorLogFile(const char* pszFileName, std::size_t cchFileName, bool fEraseContent);|Установка файла журналирования ошибочных ситуаций, возникающих в пределах управляющей подсистемы с фиксацией стека вызовов при этом.}}
{{function begin|std::uint32_t ControlSystemSetErrorLogFile(const char* pszFileName, std::size_t cchFileName, bool fEraseContent);|Установка файла журналирования ошибочных ситуаций, возникающих в пределах управляющей подсистемы с фиксацией стека вызовов при этом.}}
{{function_paramlist begin}}
{{function_paramlist begin}}
{{function_paramlist add | pszFileName | Относительное или абсолютное имя текстового файла, доступного на запись. Если файл не существует, он будет создан. Параметр может быть C-строкой, тогда значение параметра <code>cchFileName</code> должно быть равно -1 (т.е. 2<sup>''w''</sup> - 1, где ''w'' - размер машинного слова). Если же строка не завершается терминальным нулем, ее размер должен задаваться явно параметром cchFileName в байтах.}}
{{function_paramlist add | pszFileName | Относительное или абсолютное имя текстового файла, доступного на запись. Если файл не существует, он будет создан. Параметр может быть C-строкой, тогда значение параметра <code>cchFileName</code> должно быть равно -1 (т.е. 2<sup>''w''</sup> - 1, где ''w'' - размер машинного слова). Если же строка не завершается терминальным нулем, ее размер должен задаваться явно параметром cchFileName в байтах.}}

Версия 18:51, 4 июня 2019

Компоненты на верхнем уровне \ Подсистема управления \ ControlSystemSetErrorLogFile
std::uint32_t ControlSystemSetErrorLogFile(const char* pszFileName, std::size_t cchFileName, bool fEraseContent);

Установка файла журналирования ошибочных ситуаций, возникающих в пределах управляющей подсистемы с фиксацией стека вызовов при этом.

Параметры
pszFileName Относительное или абсолютное имя текстового файла, доступного на запись. Если файл не существует, он будет создан. Параметр может быть C-строкой, тогда значение параметра cchFileName должно быть равно -1 (т.е. 2w - 1, где w - размер машинного слова). Если же строка не завершается терминальным нулем, ее размер должен задаваться явно параметром cchFileName в байтах.
cchFileName Длина имени файла в байтах или -1 для C-строки.
fEraseContent Флаг, который, будучи установленным, предписывает перезаписать содержимое файла. Если флаг сброшен, новые данные будут дополнять старые.
Возвращаемое значение:
32-битовый беззнаковый код ошибки. В случае успешного вызова, возвращается нулевое значение. Код ошибки можно преобразовать в текстовое описание с помощью функции ControlSystemGetErrorDescription. См. также doxygen.