IControlSystemDomainSide::FormResponse

Компоненты на верхнем уровне \ Подсистема управления \ IControlSystemDomainSide \ FormResponse

domain_response_code_t FormResponse(return_code_t nReturnCode, _In_opt_z_count_(cbErrorDescription) const char* pErrorDescription, 
		size_type cbErrorDescription) const; /*1*/
domain_response_code_t FormResponse(return_code_t nReturnCode, _In_opt_z_ const char* pszErrorDescription) const; /*2*/
domain_response_code_t FormResponse(return_code_t nReturnCode) const; /*3*/
domain_response_code_t FormResponse() const; /*4*/

При вызове со стороны подсистемы предметной области формирует результат обработки запроса, поступившего со стороны подсистемы управления, с возможным текстовым описанием.

1. Устанавливает код ответа вместе с текстовым описанием заданной длины.
2. Устанавливает код ответа вместе с текстовым описанием, заданным C-строкой.
3. Устанавливает код ответа без текстового описания. Аналогично FormatResponse(nReturnCode, nullptr);.
4. Устанавливает код ответа по умолчанию без текстового описания. Аналогично FormatResponse(0, nullptr);.

Параметры

	nReturnCode	32-битовый код ошибки в формате chsvlib. Коды, для которых _ChsvCode_Facility(nReturnCode) == FACILITY_CHUSOV_GENERAL будут анализироваться подсистемой управления. Код, установленный в 0 (CHSVERROR_SUCCESS) является кодом по умолчанию (перегрузка 4), сидетельствующим о норамльном завершении операции. Коды с установленным старшим битом (т.е. коды, для которых выполняется предикат _ChsvSucceeded(nReturnCode)) также свидетельствуют об успешности операции, но при этом устанавливаются специальные сведения о пространстве (см. _ChsvCode_Facility) и значении кода рзультата.
[in]	pErrorDescription	Опциональное текстовое описание ошибки, передаваемое подсистеме управления. Может быть установлено в nullptr.
	cbErrorDescription	Длина строки pErrorDescription в байтах. Если pErrorDescription == nullptr, cbErrorDescription должно быть 0.

Возвращаемое значение:

Сформированный код ответа предметной области. В случае, если nResponseCode == 0 (или используется перегрузка 4) и pErrorDescription == nullptr (или используются перегрузки 3 или 4), функция просто возвращает целое значение 0. В противном случае, функция создает динамическую структуру данных с кодом и описанием ошибки и возвращает приведенный к целому указатель на нее.

См. также

domain_response_code_t

Возвращаемый тип.