IWSDDeviceProxy::GetThisDeviceMetadata method (wsdclient.h)

Retrieves device-specific metadata for this device.

Syntax

HRESULT GetThisDeviceMetadata(
  [out] WSD_THIS_DEVICE_METADATA **ppThisDeviceMetadata
);

Parameters

[out] ppThisDeviceMetadata

Reference to a WSD_THIS_DEVICE_METADATA structure that specifies the device-specific metadata of this device. 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
ppThisDeviceMetadata is NULL.

Remarks

GetThisDeviceMetadata will not cause the device proxy to retrieve metadata from the device. Instead, GetThisDeviceMetadata will return the metadata retrieved with the last call to BeginGetMetadata and EndGetMetadata. If neither of these methods has been called, GetThisDeviceMetadata 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