Brief Index      Full Index      I.M. Reference

Show_Net_User_Opt_Length


Functions

void Show_Net_User_Opt_Length (int *length)
void PShow_Net_User_Opt_Length (int keycount, HC_KEY *pathkeys, int *length)
void QShow_Net_User_Opt_Length (const char *segment, int *length)

Function Documentation

void Show_Net_User_Opt_Length ( int *  length  ) 

Finds the net effective value of length for the specified segment, and returns it.

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

DETAILS

NOTES

RESTRICTIONS

See also:
Show_User_Options, Show_User_Options_Length

void PShow_Net_User_Opt_Length ( int  keycount,
HC_KEY *  pathkeys,
int *  length 
)

Similar to Show_Net_User_Opt_Length(), 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 - size of the pathkeys array
pathkeys - 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 KInclude_Segment(). For other details, see Show_Net_User_Opt_Length()

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

Similar to Show_Net_User_Opt_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 Show_Net_User_Opt_Length()

Main Index
Brief Index      Full Index      I.M. Functions