Compartir a través de

Función WsCreateFaultFromError (webservices.h)

  • Artículo

Construye un WS_FAULT a partir de un objeto de error especificado.

Sintaxis

HRESULT WsCreateFaultFromError(
  [in]  WS_ERROR            *error,
  [in]  HRESULT             faultErrorCode,
  [in]  WS_FAULT_DISCLOSURE faultDisclosure,
  [in]  WS_HEAP             *heap,
  [out] WS_FAULT            *fault
);

Parámetros

[in] error

Puntero a una estructura WS_ERROR que representa el objeto de error desde el que se va a construir el error.

[in] faultErrorCode

Código de error HRESULT devuelto de la función que produjo un error. El valor HRESULT no puede ser un código correcto.

Este código de error nunca se incluye directamente en el error, pero se usa como mecanismo de reserva para crear una cadena de error si el objeto de error no contiene ninguna cadena de error.

[in] faultDisclosure

WS_FAULT_DISCLOSURE enumeración que controla qué información se copia del objeto de error al objeto de error.

[in] heap

Puntero a una estructura de WS_HEAP que representa el montón desde el que se va a asignar memoria para el objeto de error devuelto.

[out] fault

Puntero a una estructura WS_FAULT que representa el objeto de error devuelto. Los campos del objeto de error son correctos hasta que se llama a WsFreeHeap o WsResetHeap para liberar los recursos del montón especificados.

Valor devuelto

Si la función se realiza correctamente, devuelve NO_ERROR; de lo contrario, devuelve un código de error HRESULT.

Código devuelto Descripción
E_INVALIDARG
 Uno o más argumentos no son válidos.
E_OUTOFMEMORY
 Memoria insuficiente para completar la operación.
Otros errores
Esta función puede devolver otros errores no enumerados anteriormente.

Comentarios

Si el objeto de error contiene un error (es decir, el valor de WS_FAULT_ERROR_PROPERTY_FAULT de WS_FAULT_ERROR_PROPERTY_ID no es NULL), ese error se selecciona para construir el error devuelto.

Si el objeto de error no contiene un error (WS_FAULT_ERROR_PROPERTY_FAULT es NULL), se selecciona un error genérico con un código de error genérico (y sin texto de motivo) para construir el error devuelto.

Si el error seleccionado no incluye ningún texto de motivo, el texto del motivo del error se construye según el valor del parámetro de divulgación :

  • WS_FULL_FAULT_DISCLOSURE Todas las cadenas de error presentes en el objeto de error se anexan juntas para formar el texto del motivo. Si no hay ninguna cadena, se usa la cadena asociada al parámetro errorCode .
  • WS_MINIMAL_FAULT_DISCLOSURE se usa una cadena de error genérica.

De forma predeterminada, el idioma de cualquier información dependiente del idioma en el objeto de error es el idioma de interfaz de usuario predeterminado del usuario actual. Sin embargo, puede cambiar el idioma estableciendo la propiedad WS_ERROR_PROPERTY_LANGID. Consulte la enumeración WS_ERROR_PROPERTY_ID .

Requisitos

   
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