Función WsSetFaultErrorDetail (webservices.h)

Escriba los detalles del error almacenados en un objeto WS_ERROR .

Sintaxis

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

Parámetros

[in] error

Objeto de error que contendrá la información de error.

[in] faultDetailDescription

Puntero a una descripción del detalle del error.

Si el campo de acción de la descripción de detalles del error no es NULL, se establece como el WS_FAULT_ERROR_PROPERTY_ACTION del WS_ERROR.

La descripción del elemento de la descripción detallada del error describe el formato del elemento en el detalle del error.

[in] writeOption

Información sobre cómo se asigna el valor. Consulte WS_WRITE_OPTION para obtener más información.

value

Puntero al valor que se va a serializar.

[in] valueSize

Tamaño del valor que se va a serializar, en bytes.

Si el valor es NULL, el tamaño debe ser 0.

Valor devuelto

Esta función puede devolver uno de estos valores.

Código devuelto	Descripción
WS_E_INVALID_FORMAT	Los datos de entrada no tenían el formato esperado o no tenían el valor esperado.
E_INVALIDARG	Uno o más argumentos no son válidos.
E_OUTOFMEMORY	Se quedó sin memoria.

Comentarios

Esta API serializará el valor del campo de detalle del WS_FAULT almacenado en el objeto WS_ERROR .

Esta función admite los siguientes escenarios, en función del contenido del WS_ELEMENT_DESCRIPTION en el WS_FAULT_DETAIL_DESCRIPTION proporcionado:

• Escribir un único elemento. En este caso, los campos elementLocalName y elementNs del WS_ELEMENT_DESCRIPTION deben establecerse en el nombre local y el espacio de nombres del elemento que se va a escribir, y la descripción de tipo y tipo representa el tipo del valor que se va a serializar.
• Escribir varios elementos como un valor único. En este caso, los campos elementLocalName y elementNs del WS_ELEMENT_DESCRIPTION deben establecerse en NULL y se debe especificar un WS_STRUCT_TYPE y WS_STRUCT_DESCRIPTION . Cada campo del valor de estructura que se va a serializar debe corresponder a los elementos que se van a escribir en el detalle del error. El parámetro writeOption debe ser WS_WRITE_REQUIRED_VALUE o WS_WRITE_REQUIRED_POINTER.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 7 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2008 R2 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	webservices.h
Library	WebServices.lib
Archivo DLL	WebServices.dll