Functions
Show_Net_User_Opt_Length

Functions

void PShow_Net_User_Options_Length (int key_count, const HC_KEY *path_keys, int *length)
 Finds the net effective value of the length along a path of segments specified by an array of HC_KEY's. More...
 
void QShow_Net_User_Opt_Length (const char *segment, int *length)
 Similar to PShow_Net_User_Options_Length(), but operates on a given segment rather than the currently open one. More...
 

Detailed Description

Function Documentation

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

Finds 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- length of the user options string for a given segment. 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.

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

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

Parameters
segment- name of the segment to be queried
length- length of the user options string for a given segment. Passed by reference. Returned to user.

DETAILS

No additional details. See PShow_Net_User_Options_Length()