COLINDEX

COLINDEX

Finds the color indexes that have colors associated with them

Operating States: SGOP

Return Codes: 0, 4, 86, 87

Syntax
Description
Argument Definitions
See Also

Syntax

CALL GASK('COLINDEX', n, index-array, return-code-variable);

Description

The GASK('COLINDEX', . . . ) routine returns the color indexes that currently have colors assigned to them.

Argument Definitions

n numeric constant or numeric variable name; tells how many color indexes you want returned. If n is expressed as a variable, the variable must be initialized. The variable returns the number of colors currently assigned. If n is expressed as a constant, it will not return this value.

index-array list of numeric variables into which the used color index numbers are returned. The list of variable names can be members of an array or OF argument lists (where the arguments are variables). If you are using an array, index-array must have been declared as an array. The dimension of the array is determined by the number of color indexes you want returned. Refer to the discussion of ARRAY in SAS Language Reference: Dictionary for more information about OF argument lists.

return-code-variable numeric variable name; returns the return code of the routine call.

See Also

GASK('COLINDEX', . . . ) routine

GASK('COLREP', . . . ) routine

GSET('COLREP', . . . ) function

Chapter Contents
Previous
Next
Top of Page

n	numeric constant or numeric variable name; tells how many color indexes you want returned. If n is expressed as a variable, the variable must be initialized. The variable returns the number of colors currently assigned. If n is expressed as a constant, it will not return this value.
index-array	list of numeric variables into which the used color index numbers are returned. The list of variable names can be members of an array or OF argument lists (where the arguments are variables). If you are using an array, index-array must have been declared as an array. The dimension of the array is determined by the number of color indexes you want returned. Refer to the discussion of ARRAY in SAS Language Reference: Dictionary for more information about OF argument lists.
return-code-variable	numeric variable name; returns the return code of the routine call.

	GASK('COLINDEX', . . . ) routine
	GASK('COLREP', . . . ) routine
	GSET('COLREP', . . . ) function