IPictureMixer2::AddOutlinedText

The AddOutlinedText method of the IPictureMixer2 interface is used to add a text, time or date string, printed with the specified font, fore-/back- ground colors, outlined with the specified width and color.

Syntax

HRESULT AddOutlinedText(
            [in] ITEM_TYPE _eTextType,
            [in] OAPLOGFONT _pLogFont,
            [in] int _nTextFormat,
            [in] OVERLAY_PROPS* _pOvlProps,
            [in,out] SIZE* _pSize,
            [out] int* _pnCookie
);

Parameters

Name		Description
_eTextType		[in] Type of the text item to add. Can be one of the following constant values: eText, eDate, eTime, eFrameNumber, eSMPTETimeCode.
_pLogFont		[in] Pointer to a LOGFONT structure, used for a font description.
_nTextFormat		[in] Method used for formatting the text. For details see DrawText(), uFormat.
_pOvlProps		[in] Properties to apply to the item. For details see OVERLAY_PROPS.
_pSize		[in] Pointer to the minimum rectangle the text will be output to. After the call it points to the actual rectangle the text was output to.
_pnCookie		[out] Cookie of the item.

Return Values

Return code	Description
S_OK	Success.
E_OUTOFMEMORY	Insufficient memory.
E_POINTER	Null pointer argument.

Remarks

Use the following time format: e.g. HH:mm:ss, for details see GetTimeFormat()
Use the following date format: e.g. yyyy:MM:dd, for details see GetDateFormat()