IDWriteTextLayout::GetFontFamilyName method
Copies the font family name of the text at the specified position.
Syntax
virtual HRESULT GetFontFamilyName(
UINT32 currentPosition,
[out] WCHAR * fontFamilyName,
UINT32 nameSize,
[out, optional] DWRITE_TEXT_RANGE * textRange
) = 0;
Parameters
- currentPosition
-
Type: UINT32
The position of the text to examine.
- fontFamilyName [out]
-
Type: WCHAR*
When this method returns, contains an array of characters that receives the current font family name. You must allocate storage for this parameter.
- nameSize
-
Type: UINT32
The size of the character array in character count including the terminated NULL character.
- textRange [out, optional]
-
Type: DWRITE_TEXT_RANGE*
The range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the font family name.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Requirements
|
Minimum supported client |
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps] |
|
Minimum supported phone |
Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also