IMAPITable::FreeBookmark

The IMAPITable::FreeBookmark method releases the memory associated with a bookmark.

Quick Info

See IMAPITable : IUnknown.

HRESULT FreeBookmark(
  BOOKMARK bkPosition  
);
 

Parameters

bkPosition

[in] The bookmark to be freed, created by calling the IMAPITable::CreateBookmark method.

Return Values

S_OK

The bookmark was successfully freed.

MAPI_E_INVALID_BOOKMARK

The specified bookmark does not exist.

Remarks

The IMAPITable::FreeBookmark method releases a bookmark that is no longer needed. The bookmark is no longer valid after this call. Whenever a table is released from memory, all of its associated bookmarks are also released.

Notes to Implementers

If the caller passes one of the three predefined bookmarks in the bkPosition parameter, ignore the request and return S_OK.

See Also

IMAPITable::CreateBookmark