Brief Index      Full Index      I.M. Reference

Show_Driver


Functions

void Show_Driver (int(HC_CDECL **)(HC_ANY_ARGS) action)
void QShow_Driver (const char *segment, int(HC_CDECL **)(HC_ANY_ARGS) action)
void Show_Net_Driver (int(HC_CDECL **)(HC_ANY_ARGS) action)
void PShow_Net_Driver (int keycount, HC_KEY *pathkeys, int(HC_CDECL **)(HC_ANY_ARGS) action)
void QShow_Net_Driver (const char *segment, int(HC_CDECL **)(HC_ANY_ARGS) action)

Function Documentation

void Show_Driver ( int(HC_CDECL **)(HC_ANY_ARGS)  action  ) 

Returns the action routine that is set on the currently open segment.

Parameters:
action Pointer to an address of an action routine that is set on a particular segment. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Driver()

NOTES

The Show_Driver routines return the actual attribute values stored in the particular segment at hand. The Show_Net_Driver routines return the effective attribute value for the specified segment. The distinction is that there may or may not be an "actual" stored value for an attribute for a given segment, but there is guaranteed always to be an effective value for every attribute for every segment. Also, "Show Net" will return the cumulative effects of those attributes that concatenate as you go up and down the segment tree (Modelling Matrices and Windows).

When the value being passed back is a string, be sure you've declared your string variable to be long enough.

In C, "passed by reference" means that you have to allocate an appropriate variable, either statically or off the stack, and pass a pointer to that variable to the HOOPS routine. To generate a pointer to a variable C, you prefix the variable with a "&". In other languages you normally don't have to do anything different from usual.

The Show_Driver routines will complain if they're called and the attribute is not actually set in the segment. Use Show_Existence() to avoid this, if necessary.

void QShow_Driver ( const char *  segment,
int(HC_CDECL **)(HC_ANY_ARGS)  action 
)

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

Parameters:
segment The segment to query.
action Pointer to an address of an action routine that is set on a particular segment. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Driver()

void Show_Net_Driver ( int(HC_CDECL **)(HC_ANY_ARGS)  action  ) 

Similar to Show_Driver(), but returns the net effective settings rather than the local ones.

Parameters:
action Pointer to an address of an action routine that is set on a particular segment. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Driver()

void PShow_Net_Driver ( int  keycount,
HC_KEY *  pathkeys,
int(HC_CDECL **)(HC_ANY_ARGS)  action 
)

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

Parameters:
keycount The size of pathkeys
pathkeys An array of HC_KEY's delineating a path of segments.
action Pointer to an address of an action routine that is set on a particular 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_Driver()

void QShow_Net_Driver ( const char *  segment,
int(HC_CDECL **)(HC_ANY_ARGS)  action 
)

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

Parameters:
segment The segment to query.
action Pointer to an address of an action routine that is set on a particular segment. Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Driver()

Main Index
Brief Index      Full Index      I.M. Functions