GetBookmarkDefinition2

Top  Previous  Next

The GetBookmarkDefinition2 method retrieves an existing bookmark definition properties.

HRESULT GetBookmarkDefinition2(

[in] SHORT p_nHeading,

[in] SHORT p_nDefinition,

[out] BOOL* p_pbEnabled,

[out] BOOL* p_bDetFont,

[outstring] BSTR* p_pwsDetFont,

[out] BOOL* p_pbDetStyle,

[out] BOOL* p_pbDetBold,

[out] BOOL* p_pbDetItalic,

[out] BOOL* p_pbDetSize,

[out] FLOAT* p_pnDetSizeVal,

[out] FLOAT* p_pnDetSizePt,

[out] BOOL* p_pbDetColor,

[out] LONG* p_pnDetColor,

[out] BOOL* p_pbDispAsBold,

[out] BOOL* p_pbDispAsItalic,

[out] LONG* p_pnDispColor,

[instring] BSTR p_wsProfileName,

[in] BOOL p_bPublicProfile

);

 

Parameters:

p_nHeading

[in]heading index

p_nDefinition

[in]definition index

p_pbEnabled

[out]definition is enabled

p_pbDetFont

[out] detect font flag

p_pwsDetFont

[out] font name

p_pbDetStyle

[out] detect font style

p_pbDetBold

[out] bold font

p_pbDetItalic

[out]] italic font

p_pbDetSize

[out]] detect font size

p_pnDetSizeVal

[out] font size

p_pnDetSizePt

[out] font size rounding

p_pbDetColor

[out] detect font color

p_pnDetColor

[out] font color (RGB value)

p_pbDispAsBold

[out] display bookmark font bold

p_pbDispAsItalic

[out] display bookmark font italic

p_pnDispColor

[out] display bookmark font color

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_INVALID_BOOKMARK_DEF - wrong bookmark definition index

 

Remarks:

There can be defined maximum 9 headings and each of them can contain maximum 9 definitions.