Functions | |
void | Show_Unicode_Options (unsigned short *options) |
void | Show_One_Unicode_Option (const unsigned short *requestedOption, unsigned short *options) |
void | PShow_One_Net_Unicode_Opt (int key_count, const HC_KEY *keys, const unsigned short *requested_option, unsigned short *options) |
void | PShow_Net_Unicode_Options (int key_count, const HC_KEY *path_keys, unsigned short *options) |
void Show_Unicode_Options | ( | unsigned short * | options | ) |
Show the unicode user options string stored on the currently open segment.
options | - unicode string containing the options on the requested segment. Returned to caller. Passed by reference always |
void Show_One_Unicode_Option | ( | const unsigned short * | requestedOption, | |
unsigned short * | options | |||
) |
Similar to Show_Unicode_Options(), but returns the value of a single attribute in the currently open segment.
requestedOption | - unicode string containing the specific option you want the value of. | |
options | - unicode string containing the options on the requested segment. Returned to caller. Passed by reference always |
void PShow_One_Net_Unicode_Opt | ( | int | key_count, | |
const HC_KEY * | keys, | |||
const unsigned short * | requested_option, | |||
unsigned short * | options | |||
) |
Similar to Show_Unicode_Options(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's.
key_count | - number of keys in the keys array | |
keys | - The list of keys starting with the owning segment and following all the way back to the root segment or other desired segment. | |
requested_option | - unicode string containing the specific option you want the value of. | |
options | - unicode string containing the options on the requested segment. Returned to caller. Passed by reference always |
For additional details, see Show_Unicode_Options()
void PShow_Net_Unicode_Options | ( | int | key_count, | |
const HC_KEY * | path_keys, | |||
unsigned short * | options | |||
) |
Similar to Show_Unicode_Options(), but returns the net effective value of the attribute(s) along a path of segments specified by an array of HC_KEY's.
key_count | - number of keys in the keys array | |
path_keys | - The list of keys starting with the owning segment and following all the way back to the root segment or other desired segment. | |
options | - unicode string containing the options on the requested segment. Returned to caller. Passed by reference always |
By default, HOOPS will determine the Net attribute from the last specified key all the way to the root. If you add -1 at the end of the array, the PShow_Net routines will not proceed beyond the end of the last specified key.
For other details, see Show_Unicode_Options()