Brief Index      Full Index      Events Index      I.M. Reference

Show_Conditions

Functions

void Show_Conditional_Include (HC_KEY key, char *pathname, char *conditions)
 
void Show_Conditional_Style (HC_KEY key, char *pathname, char *conditions)
 
void Show_Conditions (char *list)
 
void PShow_Net_Conditions (int count, const HC_KEY *keys, char *options)
 
void Show_Conditions_Length (int *length)
 
void PShow_Net_Conditions_Length (int count, const HC_KEY *keys, int *length)
 
void Show_One_Condition (const char *condition, char *value)
 
void PShow_One_Net_Condition (int count, const HC_KEY *keys, const char *cname, char *options)
 

Detailed Description

Function Documentation

void Show_Conditional_Include ( HC_KEY  key,
char *  pathname,
char *  conditions 
)

Returns the pathname and valid conditions that have been established by a previous call to Conditional_Include().

Parameters
key- Key to a conditional include segment returned by a previous call to Conditional_Include().
pathname- Full pathname of the conditional include segment that is referenced by key. Passed by reference. Returned to user.
conditions- Conditions established during the inclusion of the segment referenced by key. Passed by reference. Returned to user.

DETAILS

No additional details. See Conditional_Include()

See Also
Conditional_Include, Set_Conditions, Conditional_Style, Show_Conditional_Style
void Show_Conditional_Style ( HC_KEY  key,
char *  pathname,
char *  conditions 
)

Returns the pathname and valid conditions that have been established by a previous call to Conditional_Style().

Parameters
key- Key to a conditional style segment returned by a previous call to Conditional_Style().
pathname- Full pathname of the segment that is referenced by key. Passed by reference. Returned to user.
conditions- Conditions established during the styling of the segment referenced by key. Passed by reference. Returned to user.

DETAILS

No additional details. See Conditional_Style()

See Also
Conditional_Include, Conditional_Style, Show_Conditional_Include, Set_Conditions
void Show_Conditions ( char *  list)

Returns the conditions that have been set on the currently open segment during a previous call to Set_Conditions().

Parameters
list- A list of the current conditions. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Conditions()

See Also
Conditional_Include, Conditional_Style, Show_Conditional_Style, Show_Conditional_Include
void PShow_Net_Conditions ( int  count,
const HC_KEY keys,
char *  options 
)

Similar to Show_Conditions() but returns the net effective settings along a discrete segment path.

Parameters
count- The size of pathkeys
keys- An array of HC_KEY's delineating a path of segments.
options- A list of the current conditions. 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 Show_Conditions_Length ( int *  length)

Determines string length for proper buffer allocation on a call to Show_Conditions().

Parameters
length- Length of the conditions string. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Conditions()

void PShow_Net_Conditions_Length ( int  count,
const HC_KEY keys,
int *  length 
)

Similar to Show_Conditions_Length() but shows the net effective length along a discrete segment path.

Parameters
count- The size of pathkeys
keys- An array of HC_KEY's delineating a path of segments.
length- Length of the conditions 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.

void Show_One_Condition ( const char *  condition,
char *  value 
)

Similar to Show_Conditions() but returns the value of a single option rather than the entire list.

Parameters
condition- A particular condition established by a previous call to Set_Conditions().
value- The status of the condition, either "on" or "off". Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Conditions()

void PShow_One_Net_Condition ( int  count,
const HC_KEY keys,
const char *  cname,
char *  options 
)

Similar to Show_One_Condition() but returns the net effective value along a discrete segment path.

Parameters
count- The size of keys
keys- An array of HC_KEY's delineating a path of segments.
cname- A particular condition established by a previous call to Set_Conditions.
options- The status of the condition, either "on" or "off". 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 Set_Conditions()

Brief Index      Full Index      Events Index      I.M. Reference