IWSDDeviceProxy::GetHostMetadata method (wsdclient.h)

Retrieves class-specific metadata for the device describing the features of the device and the services it hosts.

Syntax

HRESULT GetHostMetadata(
  [out] WSD_HOST_METADATA **ppHostMetadata
);

Parameters

[out] ppHostMetadata

Reference to a WSD_HOST_METADATA structure that specifies metadata. Do not release this object.

Return value

This method can return one of these values.

Possible return values include, but are not limited to, the following.

Return code Description
S_OK
Method completed successfully.
E_POINTER
ppHostMetadata is NULL.

Remarks

GetHostMetadata will not cause the device proxy to retrieve metadata from the device. Instead, GetHostMetadata will return the metadata retrieved with the last call to BeginGetMetadata and EndGetMetadata. If neither of these methods has been called, GetHostMetadata will return the metadata retrieved when the IWSDDeviceProxy object was initialized.

Upon success, the memory at ppMetadata will be valid until BeginGetMetadata or EndGetMetadata is called or until the IWSDDeviceProxy object is released.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header wsdclient.h (include Wsdapi.h)
DLL Wsdapi.dll

See also

IWSDDeviceProxy