Functions | |
void | Show_Heuristics (char *list) |
void | PShow_Net_Heuristics (int key_count, const HC_KEY *path_keys, char *list) |
void | Show_One_Heuristic (const char *type, char *value) |
void | PShow_One_Net_Heuristic (int count, const HC_KEY *keys, const char *type, char *value) |
void Show_Heuristics | ( | char * | list | ) |
Returns the heuristic settings that have been made on the currently open segment.
list | - A list of the settings made in a previous call to Set_Heuristics(). 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_Heuristics() 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 PShow_Net_Heuristics | ( | int | key_count, | |
const HC_KEY * | path_keys, | |||
char * | list | |||
) |
Similar to Show_Heuristics(), but returns the net effective settings along a discrete segment path.
key_count | - The size of pathkeys | |
path_keys | - An array of HC_KEY's delineating a path of segments. | |
list | - A list of the settings made in a previous call to Set_Heuristics(). Passed by reference. Returned to user. |
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 other details, see Show_Heuristics()
void Show_One_Heuristic | ( | const char * | type, | |
char * | value | |||
) |
Similar to Show_Heuristics() 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 PShow_One_Net_Heuristic | ( | int | count, | |
const HC_KEY * | keys, | |||
const char * | type, | |||
char * | value | |||
) |
Similar to Show_One_Heuristic() 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. |