Brief Index      Full Index      I.M. Reference

Show_Color_Map_Count


Functions

void Show_Color_Map_Count (int *count)
void QShow_Color_Map_Count (const char *segment, int *count)
void Show_Net_Color_Map_Count (int *count)
void PShow_Net_Color_Map_Count (int keycount, HC_KEY *pathkeys, int *count)
void QShow_Net_Color_Map_Count (const char *segment, int *count)

Function Documentation

void Show_Color_Map_Count ( int *  count  ) 

Shows the number of entries in the current virtual color map.

Parameters:
count - The number of colors contained in the current color map. Returned to caller. Passed by reference in all languages.

DETAILS

Show_Color_Map_Count() gives you back the length of the current colormap. This may be handy if you're about to call Show_Color_Map() and need to know how much space to allocate.

NOTES

RESTRICTIONS

See also:
Set_Color_Map, Set_Color, Show_One_Color_Map.

void QShow_Color_Map_Count ( const char *  segment,
int *  count 
)

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

Parameters:
segment - Name of the segment to be shown.
count - The number of colors contained in the current color map. Returned to caller. Passed by reference in all languages.

DETAILS

No additional details. See Show_Color_Map_Count()

void Show_Net_Color_Map_Count ( int *  count  ) 

Similar to Show_Color_Map_Count(), but returns the net effective value of the attribute(s) in the currently open segment.

Parameters:
count - The number of colors contained in the current color map. Returned to caller. Passed by reference in all languages.

DETAILS

No additional details. See Show_Color_Map_Count()

void PShow_Net_Color_Map_Count ( int  keycount,
HC_KEY *  pathkeys,
int *  count 
)

Similar to Show_Color_Map_Count(), but returns the net effective value of the attribute(s) along a path of segments specified by an array of HC_KEY's.

Parameters:
keycount - The size of the keys array
pathkeys - The list of keys starting with the owning segment and following
all the way back to the root segment or other desired segment.
count - The number of colors contained in the current color map. Returned to caller. Passed by reference in all languages.

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_Color_Map_Count()

void QShow_Net_Color_Map_Count ( const char *  segment,
int *  count 
)

Similar to Show_Color_Map_Count(), but returns the net effective value of the attribute(s) in a given segment, rather than the currently open one.

Parameters:
segment - Name of the segment to be shown.
count - The number of colors contained in the current color map. Returned to caller. Passed by reference in all languages.

DETAILS

No additional details. See Show_Color_Map_Count()

Main Index
Brief Index      Full Index      I.M. Functions