Brief Index      Full Index      I.M. Reference

Show_Line_Pattern_Explicit


Functions

void Show_Line_Pattern_Explicit (char *pattern)
void Show_Net_Line_Pattern_Explicit (char *pattern)

Function Documentation

void Show_Line_Pattern_Explicit ( char *  pattern  ) 

Returns the explicit line pattern that has been set on the currently open segment.

Parameters:
pattern A special constant. See description in Set_Line_Pattern_Explicit(). Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Line_Pattern_Explicit().

NOTES

The Show_Line_Pattern_Explicit routines return the actual attribute values stored in the particular segment at hand. Show_Net_Line_Pattern_Explicit 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_Line_Pattern_Explicit 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 Show_Net_Line_Pattern_Explicit ( char *  pattern  ) 

Similar to Show_Line_Pattern_Explicit(), but returns the net effective setting rather than the local one.

Parameters:
pattern A special constant. See description in Set_Line_Pattern(). Passed by reference. Returned to user.

DETAILS

No additional details. See Set_Line_Pattern_Explicit().

Main Index
Brief Index      Full Index      I.M. Functions