Share via

GetSubscriptionRunState method

  • Article

Obsolete. Gets the information associated with the state of the subscription item.

Syntax

HRESULT retVal = object.GetSubscriptionRunState(dwNumCookies, pCookies, pdwRunState);

Parameters

dwNumCookies [in]

Type: DWORD

An unsigned long integer value that contains the number of subscription cookies that is referenced by pCookies.

pCookies [in]

Type: const SUBSCRIPTIONCOOKIE

A constant pointer to an array of SUBSCRIPTIONCOOKIE values. A SUBSCRIPTIONCOOKIE is a GUID.

pdwRunState [out]

Type: DWORD

The address of an array of unsigned long integer values that receives a run state for each of the subscription cookies. Can be a combination of the following values, or zero if the cookie is invalid.

RS_READY (0x00000001)

RS_SUSPENDED (0x00000002)

RS_UPDATING (0x00000004)

RS_SUSPENDONIDLE (0x00010000)

RS_MAYBOTHERUSER (0x00020000)

RS_COMPLETED (0x80000000)

Remarks

The array of integers referenced by pdwRunState must be large enough to receive a value for each of the subscription cookies.

Windows Internet Explorer 7 and later. This interface is obsolete and should not be used.