Functions | |
void | Show_Marker_Symbol (char *symbol) |
void | QShow_Marker_Symbol (const char *segment, char *symbol) |
void | Show_Net_Marker_Symbol (char *symbol) |
void | PShow_Net_Marker_Symbol (int keycount, HC_KEY *pathkeys, char *symbol) |
void | QShow_Net_Marker_Symbol (const char *segment, char *symbol) |
void Show_Marker_Symbol | ( | char * | symbol | ) |
Returns the marker symbol that has been set on the currently open segment.
symbol | Special constant. See description in Set_Marker_Symbol(). Passed by reference. Returned to user. |
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_Marker_Symbol 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_Marker_Symbol | ( | const char * | segment, | |
char * | symbol | |||
) |
Similar to Show_Marker_Symbol() but operates on a given segment rather than the currently open one.
segment | The segment to query. | |
symbol | Special constant. See description in Set_Marker_Symbol(). Passed by reference. Returned to user. |
void Show_Net_Marker_Symbol | ( | char * | symbol | ) |
Similar to Show_Marker_Symbol(), but returns the net effective setting rather than the local one.
symbol | Special constant. See description in Set_Marker_Symbol(). Passed by reference. Returned to user. |
void PShow_Net_Marker_Symbol | ( | int | keycount, | |
HC_KEY * | pathkeys, | |||
char * | symbol | |||
) |
Similar to Show_Net_Marker_Symbol(), but returns the net effective setting along a discrete segment path.
keycount | The size of pathkeys | |
pathkeys | An array of HC_KEY's delineating a path of segments. | |
symbol | Special constant. See description in Set_Marker_Symbol(). Passed by reference. Returned to user. |
void QShow_Net_Marker_Symbol | ( | const char * | segment, | |
char * | symbol | |||
) |
Similar to Show_Net_Marker_Symbol() but operates on a given segment rather than the currently open one.
segment | The segment to query. | |
symbol | Special constant. See description in Set_Marker_Symbol(). Passed by reference. Returned to user. |