IUIX_RenderContext::DrawString Method

UI Layer > Interfaces > IUIX_RenderContext > IUIX_RenderContext::DrawString Method

Used for drawing a sting with specified font and color.

Syntax

HRESULT DrawString([in]                      LPWSTR                pString,
                   [in]                      LONG                  nLength,
                   [in, out]                 RECT*                 pRect,
                   [in]                      IUIX_Font*            pFont,
                   [in]                      LONG                  nColor,
                   [in]                      LONG                  nFlags,
                   [in]                      RECT*                 pClipRect,
                   [in, defaultvalue(NULL)]  IUIX_ColorsTable*     pTagColors,
                   [in, defaultvalue(NULL)]  IUIX_DrawStringTags*  pTagsOut);

Parameters

pString

[in] Value of LPWSTR containing the input string.

nLength

[in] Value of LONG containing the length of the input string.

pRect

[in, out] Pointer to RECT containing the rectangle where the string would be drawn.

pFont

[in] Pointer to IUIX_Font containing the needed font.

nColor

[in] Value of LONG containing the color in the HEX format.

nFlags

[in] Value of LONG containing the UIX_DrawStringFlags.

pClipRect

[in] Pointer to RECT containing the additional clip rectangle.

pTagColors

[in, defaultvalue(NULL)] Pointer to IUIX_ColorsTable containing the additional colors for tagged text.

pTagsOut

[in, defaultvalue(NULL)] Pointer to IUIX_DrawStringTags containing the new text tags.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IUIX_RenderContext