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

Материал из CAMaaS preliminary wiki
Перейти к навигации Перейти к поиску
м
Строка 1: Строка 1:
{{static_function
{{NavBar|{{Control system hierarchy}} \ GetErrorDescription}}
| interface=const char* GetErrorDescription(std::uint32_t code, std::uint32_t* pSize);
 
| brief_description=Функция, возвращающая read-only текстовое описание ошибки, заданной кодом ошибки. Строка завершается терминальным нулем.
{{function begin|const char* GetErrorDescription(std::uint32_t code, std::uint32_t* pSize);|Функция, возвращающая read-only текстовое описание ошибки, заданной кодом ошибки. Строка завершается терминальным нулем.}}
| function_paramlist=
{{function_paramlist begin}}
{{function_paramlist begin}}
{{function_paramlist add | code | 32-битовое беззнаковое целое, содержащее код ошибки, возвращенной какой-либо из других интерфейсных функций сервера.}}
{{function_paramlist add | code | 32-битовое беззнаковое целое, содержащее код ошибки, возвращенной какой-либо из других интерфейсных функций сервера.}}
{{function_paramlist add | pSize | Опциональный (может быть <code>NULL</code>) указатель, на выходе принимающий размер текстового описания в байтах без учета терминального нуля.}}
{{function_paramlist add | pSize | Опциональный (может быть <code>NULL</code>) указатель, на выходе принимающий размер текстового описания в байтах без учета терминального нуля.}}
{{function_paramlist end}} |
{{function_paramlist end}}
function_return_value = UTF-8 C-строка с текстовым описанием ошибки <code>code</code>. Строка только для чтения, ее не нужно освобождать.
{{function_return_value|UTF-8 C-строка с текстовым описанием ошибки <code>code</code>. Строка только для чтения, ее не нужно освобождать.}}
}}

Версия 22:39, 30 декабря 2015

Шаблон:Control system hierarchy \ GetErrorDescription
const char* GetErrorDescription(std::uint32_t code, std::uint32_t* pSize);

Функция, возвращающая read-only текстовое описание ошибки, заданной кодом ошибки. Строка завершается терминальным нулем.

Параметры
code 32-битовое беззнаковое целое, содержащее код ошибки, возвращенной какой-либо из других интерфейсных функций сервера.
pSize Опциональный (может быть NULL) указатель, на выходе принимающий размер текстового описания в байтах без учета терминального нуля.
Возвращаемое значение:
UTF-8 C-строка с текстовым описанием ошибки code. Строка только для чтения, ее не нужно освобождать.