Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This method creates a new reference item that refers to the specified object.

Syntax 

virtual DWORD CreateReference(
  LPCWSTR 
pszContainerID,
  LPCWSTR 
pszObjectID,
  wstring* 
pstrNewID
) = 0;

Parameters

pszContainerID

[in] ID of the container in which the new reference item will be created. Corresponds to the A_ARG_TYPE_ObjectID state variable.

pszObjectID

[in] ID of the object to which the new reference item refers. Corresponds to the A_ARG_TYPE_ObjectID state variable.

pstrNewID

[in, out] Pointer to an integer allocated by the caller which this method modifies to contain the ID of the newly created object. Corresponds to the A_ARG_TYPE_ObjectID 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

  • ERROR_AV_UPNP_CD_NO_SUCH_CONTAINER

  • ERROR_AV_UPNP_CD_RESTRICTED_PARENT_OBJECT

Remarks

This method corresponds to the ContentDirectory service's CreateReference action.

The ContentDirectory service does not require that this method be implemented. The IContentDirectoryImplclass therefore overrides this method to return ERROR_AV_UPNP_INVALID_ACTION.

For more information about the actions in the ContentDirectory service, see UPnP AV DCP Documentation.

Requirements

Header av_upnp.h
Library Av_upnp.lib
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also