Share via


IWSDDeviceProxy::GetHostMetadata (Compact 2013)

3/26/2014

This method retrieves class-specific metadata for the device describing the features of the device and the services it hosts.

Syntax

HRESULT GetHostMetadata(
  WSD_HOST_METADATA** ppHostMetadata
);

Parameters

  • ppHostMetadata
    [out] Reference to a WSD_HOST_METADATA structure that specifies metadata. Do not release this object.

Return Value

The following table shows the possible error code return values.

Error code

Description

S_OK

This 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 IWSDDeviceProxy::BeginGetMetadata and IWSDDeviceProxy::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

Header

wsdapi.h

Library

wsdapi.lib

See Also

Reference

IWSDDeviceProxy
Web Services on Devices Interfaces