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

Материал из CAMaaS preliminary wiki
Перейти к навигации Перейти к поиску
Строка 1: Строка 1:
{{NavBar|{{Control system hierarchy}} \ GetErrorDescription}}
{{NavBar|{{Системная иерархия:Подсистема управления}} \ GetErrorDescription}}


{{function begin|const char* GetErrorDescription(std::uint32_t code, std::uint32_t* pSize);|Функция, возвращающая read-only текстовое описание ошибки, заданной кодом ошибки. Строка завершается терминальным нулем.}}
{{function begin|const char* GetErrorDescription(std::uint32_t code, std::uint32_t* pSize);|Функция, возвращающая read-only текстовое описание ошибки, заданной кодом ошибки. Строка завершается терминальным нулем.}}

Версия 03:55, 10 января 2016

Компоненты на верхнем уровне \ Подсистема управления \ GetErrorDescription
const char* GetErrorDescription(std::uint32_t code, std::uint32_t* pSize);

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

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