ControlSystemSetErrorLogFile: различия между версиями
Перейти к навигации
Перейти к поиску
| (не показаны 3 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
{{NavBar|{{Системная иерархия:Подсистема управления}} \ | {{NavBar|{{Системная иерархия:Подсистема управления}} \ ControlSystemSetErrorLogFile}} | ||
{{function begin| | {{function begin|CAMaaS::return_code_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 в байтах.}} | ||
| Строка 7: | Строка 7: | ||
{{function_paramlist_add | fEraseContent | Флаг, который, будучи установленным, предписывает перезаписать содержимое файла. Если флаг сброшен, новые данные будут дополнять старые.}} | {{function_paramlist_add | fEraseContent | Флаг, который, будучи установленным, предписывает перезаписать содержимое файла. Если флаг сброшен, новые данные будут дополнять старые.}} | ||
{{function_paramlist end}} | {{function_paramlist end}} | ||
{{function_return_value|32-битовый беззнаковый код ошибки. В случае успешного вызова, возвращается нулевое значение. Код ошибки можно преобразовать в текстовое описание с помощью функции [[ | {{function_return_value|32-битовый беззнаковый код ошибки. В случае успешного вызова, возвращается нулевое значение. Код ошибки можно преобразовать в текстовое описание с помощью функции [[ControlSystemGetErrorDescription]]. См. также [http://www.chusov.org/doxygen/group___error_handling.html doxygen].}} | ||
{{function end}} | {{function end}} | ||
Текущая версия на 18:56, 4 июня 2019
Компоненты на верхнем уровне \ Подсистема управления \ ControlSystemSetErrorLogFile
CAMaaS::return_code_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.