MShow_Character_Attributes
Functions | |
void | MShow_Character_Attributes (HC_KEY key, int offset, int count, char *options) |
Returns attributes from a given text string on a per-character basis. More... | |
void | Show_Character_Attribute_Count (HC_KEY key, int *count) |
Returns the number of characters in a given text string that have per-character attributes. More... | |
void | Show_One_Character_Attribute (HC_KEY key, int offset, const char *which, char *options) |
Returns one per-character attribute setting from a given text string. More... | |
Detailed Description
Function Documentation
◆ MShow_Character_Attributes()
void MShow_Character_Attributes | ( | HC_KEY | key, |
int | offset, | ||
int | count, | ||
char * | options | ||
) |
Returns attributes from a given text string on a per-character basis.
- Parameters
-
key - Key to the text string on which to query per-character attributes. offset - The index within the text string on which to start the text attributes query. count - The number of characters immediately after offset on which to query the character attributes. options - A comma-separated list of attributes established by a previous call to MSet_Character_Attributes.
DETAILS
No additional details. See MSet_Character_Attributes().
NOTES
Using MShow_Character_Attributes on a text string that has no per-character attributes will return an error.
Using MShow_Character_Attributes on two characters - one with a size and hidden, and one with no attributes - will return "(size=1.0 wru, hidden), ()".
- See also
- MSet_Character_Attribute
◆ Show_Character_Attribute_Count()
void Show_Character_Attribute_Count | ( | HC_KEY | key, |
int * | count | ||
) |
Returns the number of characters in a given text string that have per-character attributes.
- Parameters
-
key - Key to a given text string. count - Number of characters that have attributes. Passed by reference. Returned to user.
DETAILS
No additional details. See MShow_Character_Attributes().
◆ Show_One_Character_Attribute()
void Show_One_Character_Attribute | ( | HC_KEY | key, |
int | offset, | ||
const char * | which, | ||
char * | options | ||
) |
Returns one per-character attribute setting from a given text string.
- Parameters
-
key - Key to the text string on which to query per-character attributes. offset - The index within the text string on which to start the text attributes query. which - The per-character attribute whose value is to be queried. options - The value of the single attribute query. Passed by reference. Returned to user.
DETAILS
No additional details. See MShow_Character_Attributes().