IUIX_Inst::CreateFontFromHandle Method

From Tracker Software PDF SDK
Jump to: navigation, search

Creates new object of IUIX_Font interface from other font HANDLE_T value.


HRESULT CreateFontFromHandle([in]                     HANDLE_T     hFont,
                             [in, defaultvalue(0.0)]  double       nNewFontSize,
                             [in, defaultvalue(0)]    LONG         nFlags,
                             [in, defaultvalue(0)]    LONG         nFlagsMask,
                             [out, retval]            IUIX_Font**  pFont);


[in] HANDLE_T value of already existing font object.
[in, defaultvalue(0.0)] specifies new size of a given font.
[in, defaultvalue(0)] specifies font style with flags from UIX_CreateFontFlags enumeration.
[in, defaultvalue(0)] specifies style mask with flags from UIX_CreateFontFlags enumeration. This parameter removes specified styles from current font and applies only those flags of nFlags parameter to the new font that were set in nFlagsMask. For instance, if previous font style was UIX_CreateFont_Underline, and new font style in nFlags parameter is set to UIX_CreateFont_Bold with nStyleMask parameter set to (UIX_CreateFont_Bold | UIX_CreateFont_Underline), then a given font will be first set to non-underlined, and then to bold. If nStyleMask is set to UIX_ComboItemStyle_Bold, then font style will be changed to bold, but still remain underlined.
[out, retval] return object of IUIX_Font interface.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also