Edit

Share via

WsGetMetadataProperty function (webservices.h)

  • Article

Retrieves a specified WS_METADATA object property. The property to retrieve is identified by a WS_METADATA_PROPERTY_ID input parameter.

Note  The data returned by this function is valid until the metadata object is released or reset. The data should not be modified.
 

Syntax

HRESULT WsGetMetadataProperty(
  [in]           WS_METADATA             *metadata,
  [in]           WS_METADATA_PROPERTY_ID id,
                 void                    *value,
  [in]           ULONG                   valueSize,
  [in, optional] WS_ERROR                *error
);

Parameters

[in] metadata

A pointer to a Metadata object containing the desired property. This parameter must be a valid WS_METADATA object.

[in] id

Identifier value of the property to retrieve.

value

A reference to a location for storing the retrieved property value. The pointer must have an alignment compatible with the type of the property.

[in] valueSize

The byte-length buffer size allocated by the caller to store the retrieved property value.

[in, optional] error

A pointer to a WS_ERROR object where additional information about the error should be stored if the function fails.

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.
E_OUTOFMEMORY
 Ran out of memory.
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