ControlSystemDomainSideRef::FormResponse

Материал из CAMaaS preliminary wiki
Перейти к навигации Перейти к поиску
unique_drc FormResponse(return_code_t nReturnCode, const char* pErrorDescription, size_type cbErrorDescription) const noexcept; //1
unique_drc FormResponse(return_code_t nReturnCode, const char* pszErrorDescription) const noexcept; //2
template <class traits_t, class alloc_t>
unique_drc FormResponse(return_code_t nReturnCode, const std::basic_string<char, traits_t, alloc_t>& strErrorDescription) const noexcept; //3
unique_drc FormResponse(return_code_t nReturnCode) const noexcept; //4

Формирует код завершения предметной области в структуру domain_response_code_t и возвращает его через экземпляр unique_drc.

  1. Позволяет задать текстовое описание ответа указателем на байтовую строку заданной длины.
  2. Позволяет задать текстовое описание ответа C-строкой с терминальным нулем.
  3. Позволяет задать текстовое описание ответа C++-строкой std::basic_string.
  4. Задает код ответа без текстового описания.
Параметры шаблона
traits_tВычисляемый дедукцией тип, задающий характеристики строки. См. std::char_traits.
alloc_tВычисляемый дедукцией тип, задающий тип менеджера памяти, используемого для управления буферами класса std::basic_string.
Параметры
nReturnCodeКод ответа return_code_t.
[in]pErrorDescriptionУказатель на строку с текстовым описанием ответа. Может быть nullptr, если cbErrorDescription равен нулю.
cbErrorDescriptionДлина строки pErrorDescription в байтах.
[in]pszErrorDescriptionC-строка с терминальным нулем с текстовым описанием ответа. Может быть nullptr.
strErrorDescriptionC++-строка std::basic_string с текстовым описанием ответа.
Возвращаемое значение:
Сформированный в unique_drc код ответа.
См. также
IControlSystemDomainSide::FormResponseПри вызове со стороны подсистемы предметной области формирует результат обработки запроса, поступившего со стороны подсистемы управления, с возможным текстовым описанием.