WsGetMetadataProperty function

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

C++


HRESULT WINAPI  WsGetMetadataProperty(
  _In_     WS_METADATA*            metadata,
  _In_     WS_METADATA_PROPERTY_ID id,
           void*                   value,
  _In_     ULONG                   valueSize,
  _In_opt_ WS_ERROR*               error
);

Parameters

metadata [in]: A pointer to a Metadata object containing the desired property. This parameter must be a valid WS_METADATA object.
id [in]: 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.
valueSize [in]: The byte-length buffer size allocated by the caller to store the retrieved property value.
error [in, optional]: 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

Minimum supported client	Windows 7 [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2008 R2 [desktop apps \| Windows Store apps]
Header	WebServices.h
Library	WebServices.lib
DLL	WebServices.dll

Community Additions

ADD