IContentDirectory::BrowseMetadata (Compact 7)

3/12/2014

This method returns DIDL-Lite XML that contains the metadata for the specified object.

Syntax

virtual DWORD BrowseMetadata(
  LPCWSTR pszObjectID,
  LPCWSTR pszFilter,
  wstring* pstrResult,
  unsigned long* pUpdateID
) = 0;

Parameters

• pszObjectID
  [in] ID of the object being browsed. The root object in the ContentDirectory service data store has an ID of 0. Corresponds to the A_ARG_TYPE_ObjectID state variable.

• pszFilter
  [in] Filter string that specifies the metadata properties to be returned in the pstrResult parameter. Corresponds to the A_ARG_TYPE_Filter state variable. For more information about the syntax of strings passed in this parameter, see UPnP Forum AV Web site.

• pstrResult
  [in, out] Pointer to a string that, upon return, contains DIDL-Lite XML that represents the requested data. Corresponds to the A_ARG_TYPE_Result state variable.

• pUpdateID
  [in, out] ContainerUpdateID of the container, if the pszObjectID parameter refers to a container. Corresponds to the A_ARG_TYPE_UpdateID state variable.

Return Value

Custom implementations can return appropriate error codes. Should return SUCCESS_AV if the method succeeds. Otherwise, should return an error code defined in WinError.h or UPnP.h, or one of the UPnP AV-specific return values specified in UPnPAVError, especially the following errors documented for this action in the ContentDirectory DCP documentation:

• ERROR_AV_UPNP_ACTION_FAILED
• ERROR_AV_UPNP_CD_NO_SUCH_OBJECT

Remarks

This method corresponds to the ContentDirectory service's Browse action with the BrowseFlag parameter set to BrowseMetadata. The IContentDirectory::BrowseChildren method enables browsing child objects.

To use the information returned in pstrResult, use the DIDL-Lite functionality provided by the parser class. The parser::GetFirstObject method accepts a DIDL-Lite string, like that returned in pstrResult, to enable iteration over all DIDL-Lite objects represented by the passed XML.

For more information about the actions, and the syntax expected by actions, in the ContentDirectory service, see UPnP Forum AV Web site.

Requirements

See Also

Reference

IContentDirectory
IContentDirectory::BrowseChildren
parser (UPnP AV)
parser::GetFirstObject
UPnPAVError