Share via


IContentDirectory::GetSystemUpdateID

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method returns the current value of the SystemUpdateID state variable. Control points that poll (instead of using eventing) can determine if the contents of the ContentDirectory instance's data store have changed using the returned ID.

Syntax

virtual DWORD GetSystemUpdateID(
  unsigned long* pId
) = 0;

Parameters

  • pId
    [in, out] Pointer to an integer allocated by the caller that this method modifies to contain the current value of the SystemUpdateID state variable. Corresponds to the SystemUpdateID 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 error documented for this action in the ContentDirectory DCP documentation:

  • ERROR_AV_UPNP_ACTION_FAILED

Remarks

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

For more information about the actions and SystemUpdateID and change management 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

Reference

IContentDirectory
UPnPAVError