Поделиться через

Функция WsSetFaultErrorDetail (webservices.h)

  • Статья

Запишите сведения об ошибке, хранящиеся в объекте WS_ERROR .

Синтаксис

HRESULT WsSetFaultErrorDetail(
  [in] WS_ERROR                          *error,
  [in] const WS_FAULT_DETAIL_DESCRIPTION *faultDetailDescription,
  [in] WS_WRITE_OPTION                   writeOption,
       const void                        *value,
  [in] ULONG                             valueSize
);

Параметры

[in] error

Объект ошибки, который будет содержать сведения об ошибке.

[in] faultDetailDescription

Указатель на описание сведений об ошибке.

Если поле действия описания ошибки не равно NULL, оно задается как WS_FAULT_ERROR_PROPERTY_ACTIONWS_ERROR.

Описание элемента подробного описания ошибки описывает формат элемента в сведениях об ошибке.

[in] writeOption

Сведения о выделении значения. Дополнительные сведения см. в разделе WS_WRITE_OPTION .

value

Указатель на сериализуемое значение.

[in] valueSize

Размер сериализуемого значения в байтах.

Если значение равно NULL, размер должен быть равен 0.

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

Эта функция может возвращать одно из этих значений.

Код возврата Описание
WS_E_INVALID_FORMAT
 Входные данные не были в ожидаемом формате или не имели ожидаемого значения.
E_INVALIDARG
 Один или несколько аргументов недопустимы.
E_OUTOFMEMORY
 Не хватает памяти.

Комментарии

Этот API сериализует значение поля сведений WS_FAULT , хранящегося в объекте WS_ERROR .

Эти функции поддерживают следующие сценарии на основе содержимого WS_ELEMENT_DESCRIPTION в предоставленном WS_FAULT_DETAIL_DESCRIPTION :

  • Написание одного элемента. В этом случае полям elementLocalName и elementNs WS_ELEMENT_DESCRIPTION следует задать локальное имя и пространство имен записываемого элемента, а описание типа и типа представляет тип сериализуемого значения.
  • Запись нескольких элементов в виде одного значения. В этом случае полям elementLocalName и elementNs WS_ELEMENT_DESCRIPTION следует задать значение NULL, а также указать WS_STRUCT_TYPE и WS_STRUCT_DESCRIPTION . Каждое поле сериализуемого значения структуры должно соответствовать элементам для записи в сведения об ошибке. Параметр writeOption должен быть WS_WRITE_REQUIRED_VALUE или WS_WRITE_REQUIRED_POINTER.

Требования

Требование Значение
Минимальная версия клиента Windows 7 [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2008 R2 [классические приложения | Приложения UWP]
Целевая платформа Windows
Header webservices.h
Библиотека WebServices.lib
DLL WebServices.dll