AddBookmarkDefinition2

Top  Previous  Next

The AddBookmarkDefinition2 method adds a new bookmark definition, having the characteristics specified by the method parameters.

HRESULT AddBookmarkDefinition2(

[in] SHORT p_nHeading,

[in] BOOL p_bEnabled,

[in] BOOL p_bDetFont,

[instring] BSTR p_wsDetFont,

[in] BOOL p_bDetStyle,

[in] BOOL p_bDetBold,

[in] BOOL p_bDetItalic,

[in] BOOL p_bDetSize,

[in] FLOAT p_nDetSizeVal,

[in] FLOAT p_nDetSizePt,

[in] BOOL p_bDetColor,

[in] LONG p_nDetColor,

[in] BOOL p_bDispAsBold,

[in] BOOL p_bDispAsItalic,

[in] LONG p_nDispColor,

[out] SHORT* p_nDefinition,

[instring] BSTR p_wsProfileName,

[in] BOOL p_bPublicProfile

);

 

Parameters:

p_nHeading

[in]heading index where to add the definition

p_bEnabled

[in]definition is enabled

p_bDetFont

[in] detect font flag

p_wsDetFont

[in] font name

p_bDetStyle

[in] detect font style

p_bDetBold

[in] bold font

p_bDetItalic

[in] italic font

p_bDetSize

[in] detect font size

p_nDetSizeVal

[in] font size

p_nDetSizePt

[in] font size rounding

p_bDetColor

[in] detect font color

p_nDetColor

[in] font color (RGB value)

p_bDispAsBold

[in] display bookmark font bold

p_bDispAsItalic

[in] display bookmark font italic

p_nDispColor

[in] display bookmark font color

p_nDefinition

[out] definition index, if added. If the definition was not added, -1

p_wsProfileName

[in] pointer to a BSTR containing the profile to modify. If this parameter is an empty string, the current active profile is used.

p_bPublicProfile

[in] Flag if the profile is a public or a private profile.

 

Return values:

S_OK on success or COM error code

NV_NOT_INITIALIZED - Initialize was not called

NV_INVALID_BOOKMARK_HEAD - wrong bookmark header index

NV_PUBLIC_PROFILE - you cannot change public profiles only on server

 

Remarks:

If you want to define a new heading, pass next heading index in the p_nHeading parameter. There can be defined maximum 9 headings and each of them can contain maximum 9 definitions.