MI_SubscriptionDeliveryOptions_SetBookmark function (mi.h)

Sets a bookmark for subscription indication delivery.

Syntax

MI_INLINE MI_Result MI_SubscriptionDeliveryOptions_SetBookmark(
  [in, out] MI_SubscriptionDeliveryOptions *self,
            const MI_Char                  *value
);

Parameters

[in, out] self

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.

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.

Remarks

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

Requirements

See also

MI_SubscriptionDeliveryOptions

MI_SubscriptionDeliveryOptions_GetBookmark