Show_Unicode_Options

Functions

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. More...
 
HC_BOOLEAN 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. More...
 
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. More...
 
void Show_Unicode_Options (unsigned short *options)
 Show the unicode user options string stored on the currently open segment. More...
 

Detailed Description

Function Documentation

◆ PShow_Net_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.

Parameters
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

DETAILS

As with all PShow_Net_* routines, pathkeys[0] represents the lowest (a.k.a the "most local" or "leaf"), and pathkeys[keycount-1] represents the highest segment. If the path is incomplete, missing segments are filled in if possible. Missing segments must be part of the same direct ancestry in order to be filled in. If the desired path contains an include link, the shortest unambiguous set of pathkeys would be [leaf, includelink, root], where includelink is the return value from Include_Segment().
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()

◆ PShow_One_Net_Unicode_Opt()

HC_BOOLEAN 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.

Parameters
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

DETAILS

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 additional details, see Show_Unicode_Options()

◆ Show_One_Unicode_Option()

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.

Parameters
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

DETAILS

No additional details. See Show_Unicode_Options()

◆ Show_Unicode_Options()

void Show_Unicode_Options ( unsigned short *  options)

Show the unicode user options string stored on the currently open segment.

Parameters
options- unicode string containing the options on the requested segment. Returned to caller. Passed by reference always

DETAILS

Show_Unicode_Options() allows you to query the Unicode option string containing 'name=value' pairs that you may have stored in the HOOPS segment tree.

See also
Set_Unicode_Options