Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Gets whether characters are displayed as subscript.
Syntax
HRESULT GetSubscript(
long *pValue
);
Parameters
pValue
Type: long*
A tomBool value that can be one of the following.
Value | Meaning |
---|---|
tomTrue | Characters are displayed as subscript. |
tomFalse | Characters are not displayed as subscript. |
tomUndefined | The Subscript property is undefined. |
Return value
Type: HRESULT
If the method succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.
Return code | Description |
---|---|
|
Invalid argument. |
|
The font object is attached to a range that has been deleted. |
Remarks
This property corresponds to the CFE_SUBSCRIPT effect described in the CHARFORMAT2 structure.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows Vista [desktop apps only] |
Minimum supported server | Windows Server 2003 [desktop apps only] |
Target Platform | Windows |
Header | tom.h |
DLL | Msftedit.dll |
See also
Conceptual
Reference