IWSDDeviceProxy::GetAllMetadata method (wsdclient.h)

Retrieves all metadata for this device.

Syntax

HRESULT GetAllMetadata(
  [out] WSD_METADATA_SECTION_LIST **ppMetadata
);

Parameters

[out] ppMetadata

Reference to a WSD_METADATA_SECTION_LIST structure that specifies all metadata related to a 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
ppMetadata is NULL.

Remarks

This method is supplied so that extended metadata may be accessed. Manufacturer, service host and device-specific metadata is best obtained using methods provided specifically for those purposes.

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