Skip to main content
MI_SubscriptionDeliveryOptions_SetBookmark function

Sets a bookmark for subscription indication delivery.

Syntax


MI_Result MI_SubscriptionDeliveryOptions_SetBookmark(
  _Inout_  MI_SubscriptionDeliveryOptions *self,
  _In_z_ const MI_Char *value
);

Parameters

self [in, out]

A pointer to a MI_SubscriptionDeliveryOptions structure.

value

A null-terminated string that represents the bookmark that was retrieved from a previous indication result delivery, or one of two constants (MI_SUBSCRIBE_BOOKMARK_OLDEST or MI_SUBSCRIBE_BOOKMARK_NEWEST) that specify when a subscription should start.

ValueMeaning
MI_SUBSCRIBE_BOOKMARK_OLDEST
L"MI_SUBSCRIBE_BOOKMARK_OLDEST"

Start the subscription from the earliest possible indication.

MI_SUBSCRIBE_BOOKMARK_NEWEST
L"MI_SUBSCRIBE_BOOKMARK_NEWEST"

Start the subscription from this point.

 

Return value

A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters passed to the function were not valid.

MI_RESULT_FAILED

A failure not covered by other MI_Result error codes.

 

Remarks

This function tells the server that bookmarks are required, and (if supported) it should return bookmarks with the indication results.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

See also

MI_SubscriptionDeliveryOptions
MI_SubscriptionDeliveryOptions_GetBookmark