Microsoft DirectX 9.0

IFullScreenVideoEx::GetCaption

The GetCaption method retrieves the caption associated with the full-screen window.

Syntax

HRESULT GetCaption(
  BSTR *pstrCaption
);

Parameters

pstrCaption

[out] Pointer to a BSTR that receives the caption.

Return Values

Returns an HRESULT value. Possible values include the following.

Value Description
E_OUTOFMEMORY Insufficient memory
E_POINTER NULL pointer argument
S_OK Success

Remarks

The caption is visible when the window is minimized.

The caller must release the returned string, by calling the SysFreeString function.

See Also