Brief Index      Full Index      I.M. Reference

Show_Unicode_Options


Functions

void Show_Unicode_Options (const unsigned short *options)
void Show_Net_Unicode_Options (const unsigned short *options)
void Show_One_Unicode_Option (const unsigned short *requestedOption, const unsigned short *options)
void Show_One_Net_Unicode_Option (const unsigned short *requestedOption, const unsigned short *options)
void QShow_Unicode_Options (const char *segment, const unsigned short *options)
void QShow_Net_Unicode_Options (const char *segment, const unsigned short *options)
void QShow_One_Unicode_Option (const char *segment, const unsigned short *requestedOption, const unsigned short *options)
void QShow_One_Net_Unicode_Opt (const char *segment, const unsigned short *requestedOption, const unsigned short *options)
void PShow_One_Net_Unicode_Opt (int keyCount, HC_KEY *keys, const unsigned short *requestedOption, const unsigned short *options)
void PShow_Net_Unicode_Options (int keycount, HC_KEY *pathkeys, const unsigned short *options)

Function Documentation

void Show_Unicode_Options ( const 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.

NOTES

RESTRICTIONS

See also:
Set_Unicode_Options

void Show_Net_Unicode_Options ( const unsigned short *  options  ) 

Similar to Show_Unicode_Options(), but returns the net effective value of the attribute(s) in the currently open segment.

Parameters:
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()

void Show_One_Unicode_Option ( const unsigned short *  requestedOption,
const 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()

void Show_One_Net_Unicode_Option ( const unsigned short *  requestedOption,
const unsigned short *  options 
)

Similar to Show_Unicode_Options(), but returns the net effective 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()

void QShow_Unicode_Options ( const char *  segment,
const unsigned short *  options 
)

Similar to Show_Unicode_Options(), but operates on a given segment rather than the currently open one.

Parameters:
segment - Name of the segment to be queried
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()

void QShow_Net_Unicode_Options ( const char *  segment,
const unsigned short *  options 
)

Similar to Show_Unicode_Options(), but returns the net effective value of the attribute(s) in a given segment, rather than the currently open one.

Parameters:
segment - Name of the segment to be queried
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()

void QShow_One_Unicode_Option ( const char *  segment,
const unsigned short *  requestedOption,
const unsigned short *  options 
)

Similar to Show_Unicode_Options(), but returns the value of a single attribute in a given segment, rather than the currently open one.

Parameters:
segment - Name of the segment to be queried
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()

void QShow_One_Net_Unicode_Opt ( const char *  segment,
const unsigned short *  requestedOption,
const unsigned short *  options 
)

Similar to Show_Unicode_Options(), but returns the net effective value of a single attribute in a given segment, rather than the currently open one.

Parameters:
segment - Name of the segment to be queried
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()

void PShow_One_Net_Unicode_Opt ( int  keyCount,
HC_KEY *  keys,
const unsigned short *  requestedOption,
const 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:
keyCount - 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.
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()

void PShow_Net_Unicode_Options ( int  keycount,
HC_KEY *  pathkeys,
const 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:
keycount - number of keys in the keys array
pathkeys - 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 KInclude_Segment(). For other details, see Show_Net_Unicode_Options()

Main Index
Brief Index      Full Index      I.M. Functions