GetWatermarkImage

Top  Previous  Next

The GetWatermarkImage method retrieves an existing image watermark properties.

HRESULT GetWatermarkImage(

[in] SHORT p_nWatermark, 

[outstring] LPWSTR* p_pwsName, 

[outstring] LPWSTR* p_pwsFile, 

[out] BOOL* p_pbVisible, 

[out] BOOL* p_pbFit, 

[out] LONG* p_pnMarginLeft, 

[out] LONG* p_pnMarginRight, 

[out] LONG* p_pnMarginTop, 

[out] LONG* p_pnMarginBottom, 

[out] BOOL* p_pbCenterHorizontally, 

[out] BOOL* p_pbCenterVertically, 

[out] BOOL* p_pbAlignRightMargin, 

[out] BOOL* p_pbAlignBottomMargin, 

[out] LONG* p_pnOriginLeft, 

[out] LONG* p_pnOriginTop, 

[out] LONG* p_pnWidth, 

[out] LONG* p_pnHeight, 

[out] BOOL* p_pbAspectRatio, 

[out] BOOL* p_pbUseTranspColor, 

[out] COLORREF* p_pnTransparentColor, 

[out] SHORT* p_pnColorVar, 

[out] SHORT* p_pnRotation, 

[out] WORD* p_pnOpacity, 

[out] WORD* p_pnPrintOn, 

[out] BOOL* p_pbPrintAsBackground, 

[outstring] LPWSTR* p_pwsPrintRange, 

[out] WORD* p_pnPrintPriority, 

[in] LPCWSTR p_wsProfileName, 

[in] BOOL p_bPublicProfile

);

 

Parameters:

p_nWatermark,

[in] - watermark index

p_pwsName,

[out, string] - watermark name

p_pwsFile

[out, string] - image file

p_pbVisible

[out] - flag if watermark is enabled

p_pbFit

[out] - flag, image fit to margins

p_pnMarginLeft

[out] - left margin

p_pnMarginRight

[out] - right margin

p_pnMarginTop

[out] - top margin

p_pnMarginBottom

[out] - bottom margin

p_pbCenterHorizontally

[out] - flag, image centered horizontally

p_pbCenterVertically

[out] - flag, image centered vertically

p_pbAlignRightMargin

[out] - flag, align image to right margin

p_pbAlignBottomMargin

[out] - flag, align image to bottom margin

p_pnOriginLeft

[out] - left origin position

p_pnOriginTop

[out] - top origin position

p_pnWidth

[out] - image width

p_pnHeight

[out] - image height

p_pbAspectRatio

[out] - flag, keep image aspect ratio

p_pbUseTranspColor

[out] -flag, use transparent color

p_pnTransparentColor

[out] - transparent color

p_pnColorVar

[out] - color variation

p_pnRotation

[out] - image rotation angle

p_pnOpacity

[out] - image opacity

p_pnPrintOn

[out] - one of next values: 

0 - All pages

1 - First page

2 - Even pages

3 - Odd pages

4 - Page range

p_pbPrintAsBackground

[out] - flag, print image as background

p_pwsPrintRange

[out] - page range, like "2 - 5"

p_pnPrintPriority

[out] - print priority of the image watermark

p_wsProfileName

[in, string] - pointer to a null terminated Unicode string containing the profile to modify. 

If this parameter is an empty string, the current active profile is used.

p_bPublicProfile

[in] - flag, profile is a public profile

 

 

Return values:

S_OK on success or COM error code

NV_NOT_INITIALIZED - Initialize was not called

NV_INVALID_WATERMARK_IMG - wrong image watermark index