Functions | |
void | Show_User_Options (char *list) |
void | QShow_User_Options (const char *segment, char *list) |
void | Show_Net_User_Options (char *list) |
void | PShow_Net_User_Options (int keycount, HC_KEY *pathkeys, char *list) |
void | QShow_Net_User_Options (const char *segment, char *list) |
void | Show_One_User_Option (const char *type, char *value) |
void | QShow_One_User_Option (const char *segment, const char *type, char *value) |
void | Show_One_Net_User_Option (const char *type, char *value) |
void | PShow_One_Net_User_Option (int count, HC_KEY *keys, const char *type, char *value) |
void | QShow_One_Net_User_Option (const char *segment, const char *type, char *value) |
void Show_User_Options | ( | char * | list | ) |
Returns the user options that have been set on the currently open segment.
list | A list of name = value pairs. 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_User_Options 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.
Show_User_Options may be used to return user data that has been associated with a piece of geometry. This must be done during a block using Open_Geometry().
void QShow_User_Options | ( | const char * | segment, | |
char * | list | |||
) |
Similar to Show_User_Options() but operates on a given segment rather than the currently open one.
segment | The segment to query. | |
list | A list of name = value pairs. Passed by reference. Returned to user. |
void Show_Net_User_Options | ( | char * | list | ) |
Similar to Show_User_Options(), but returns the net effective settings rather than the local ones.
list | A list of name = value pairs. Passed by reference. Returned to user. |
void PShow_Net_User_Options | ( | int | keycount, | |
HC_KEY * | pathkeys, | |||
char * | list | |||
) |
Similar to Show_Net_User_Options(), but returns the net effective settings along a discrete segment path.
keycount | The size of pathkeys | |
pathkeys | An array of HC_KEY's delineating a path of segments. | |
list | A list of name = value pairs. Passed by reference. Returned to user. |
void QShow_Net_User_Options | ( | const char * | segment, | |
char * | list | |||
) |
Similar to Show_Net_User_Options() but operates on a given segment rather than the currently open one.
segment | The segment to query. | |
list | A list of name = value pairs. Passed by reference. Returned to user. |
void Show_One_User_Option | ( | const char * | type, | |
char * | value | |||
) |
Similar to Show_User_Options() but returns a single setting, rather than the entire set.
type | The type in type = value. | |
value | The value of type. Passed by reference. Returned to user. |
void QShow_One_User_Option | ( | const char * | segment, | |
const char * | type, | |||
char * | value | |||
) |
Similar to Show_One_User_Option() but operates on a given segment rather than the currently open one.
segment | The segment to query. | |
type | The type in type = value. | |
value | The value of type. Passed by reference. Returned to user. |
void Show_One_Net_User_Option | ( | const char * | type, | |
char * | value | |||
) |
Similar to Show_One_User_Option() but returns the net effective setting rather than the local one.
type | The type in type = value. | |
value | The value of type. Passed by reference. Returned to user. |
void PShow_One_Net_User_Option | ( | int | count, | |
HC_KEY * | keys, | |||
const char * | type, | |||
char * | value | |||
) |
Similar to Show_One_Net_User_Option() but returns the net settings along a discrete path.
count | The size of keys | |
keys | An array of HC_KEY's delineating a path of segments. | |
type | The type in type = value. | |
value | The value of type. Passed by reference. Returned to user. |
void QShow_One_Net_User_Option | ( | const char * | segment, | |
const char * | type, | |||
char * | value | |||
) |
Similar to Show_One_Net_User_Option() but operates on a given segment rather than the currently open one.
segment | The segment to query. | |
type | The type in type = value. | |
value | The value of type. Passed by reference. Returned to user. |