Functions
Show_Net_Unicode_Opt_Length

Functions

void PShow_Net_Unicode_Options_Length (int key_count, const HC_KEY *path_keys, int *length)
 Returns the net effective value of the length along a path of segments specified by an array of HC_KEY's. More...
 
void QShow_Net_Unicode_Opt_Length (const char *segment, int *length)
 Similar to pShow_Net_Unicode_Opt_Length(), but operates on a given segment rather than on a path of segments. More...
 
void Show_One_Uni_Option_Length (const unsigned short *text, int *length)
 Similar to PShow_Net_Unicode_Opt_Length(), but returns the value of a single attribute in the currently open segment. More...
 
void QShow_One_Uni_Option_Length (const char *segment, const unsigned short *text, int *length)
 Similar to PShow_Net_Unicode_Opt_Length(), but returns the value of a single attribute in a given segment. More...
 
void QShow_One_Net_Uni_Opt_Len (const char *segment, const unsigned short *text, int *length)
 Similar to PShow_Net_Unicode_Opt_Length(), but returns the net effective value of a single attribute in a given segment. More...
 
void PShow_One_Net_Uni_Opt_Len (int count, const HC_KEY *keys, const unsigned short *which, int *length)
 Similar to PShow_Net_Unicode_Opt_Length(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's. More...
 

Detailed Description

Function Documentation

void PShow_Net_Unicode_Options_Length ( int  key_count,
const HC_KEY path_keys,
int *  length 
)

Returns the net effective value of the length along a path of segments specified by an array of HC_KEY's.

Parameters
key_count- size of the pathkeys array
path_keys- The list of keys starting with the owning segment and following back to some desired segment.
length- net length of the unicode options string. Passed by reference. Returned to user.

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_Net_Unicode_Opt_Length()

void PShow_One_Net_Uni_Opt_Len ( int  count,
const HC_KEY keys,
const unsigned short *  which,
int *  length 
)

Similar to PShow_Net_Unicode_Opt_Length(), but returns the net effective value of a single attribute along a path of segments specified by an array of HC_KEY's.

Parameters
count- size of the keys array
keys- The list of keys starting with the owning segment and following back to some desired segment.
which- encoded unicode text.
length- net length of the unicode options string. Passed by reference. Returned to user.

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 PShow_Net_Unicode_Opt_Length()

void QShow_Net_Unicode_Opt_Length ( const char *  segment,
int *  length 
)

Similar to pShow_Net_Unicode_Opt_Length(), but operates on a given segment rather than on a path of segments.

Parameters
segment- name of the segment to be queried
length- net length of the unicode options string. Passed by reference. Returned to user.

DETAILS

No additional details. See PShow_Net_Unicode_Opt_Length()

void QShow_One_Net_Uni_Opt_Len ( const char *  segment,
const unsigned short *  text,
int *  length 
)

Similar to PShow_Net_Unicode_Opt_Length(), but returns the net effective value of a single attribute in a given segment.

Parameters
segment- name of the segment to be queried
text- encoded unicode text.
length- net length of the unicode options string. Passed by reference. Returned to user.

DETAILS

No additional details. See PShow_Net_Unicode_Opt_Length()

void QShow_One_Uni_Option_Length ( const char *  segment,
const unsigned short *  text,
int *  length 
)

Similar to PShow_Net_Unicode_Opt_Length(), but returns the value of a single attribute in a given segment.

Parameters
segment- name of the segment to be queried
text- encoded unicode text.
length- net length of the unicode options string. Passed by reference. Returned to user.

DETAILS

No additional details. See Show_Net_Unicode_Opt_Length()

void Show_One_Uni_Option_Length ( const unsigned short *  text,
int *  length 
)

Similar to PShow_Net_Unicode_Opt_Length(), but returns the value of a single attribute in the currently open segment.

Parameters
text- encoded unicode text.
length- net length of the unicode options string. Passed by reference. Returned to user.

DETAILS

No additional details. See PShow_Net_Unicode_Opt_Length()