WsGetFaultErrorProperty function (webservices.h)

  • Article

Retrieves a Fault error property of an WS_ERROR object referenced by the error parameter.

Syntax

HRESULT WsGetFaultErrorProperty(
  [in] WS_ERROR                   *error,
  [in] WS_FAULT_ERROR_PROPERTY_ID id,
       void                       *buffer,
  [in] ULONG                      bufferSize
);

Parameters

[in] error

A pointer to the WS_ERROR object with the property to retrieve.

[in] id

Represents an identifier of the fault error property to retrieve.

buffer

A pointer referencing the location to store the retrieved fault error property.

Note  The pointer must have an alignment compatible with the type of the property.
 

[in] bufferSize

The number of bytes allocated by the caller to store the retrieved property.

Return value

This function can return one of these values.

Return code Description
E_INVALIDARG
 The property id was not supported for this object or the specified buffer was not large enough for the value.
Other Errors
This function may return other errors not listed above.

Requirements

Requirement Value
Minimum supported client Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header webservices.h
Library WebServices.lib
DLL WebServices.dll