NAME

INQUIRE COLOUR MAPPING FACILITIES - inquire for colour mapping facilities for the specified workstation type

SYNOPSIS

C Syntax

void

pinq_colr_map_facs ( type, length, start, error_ind, colr_map_facs, total_length )

Pint              type;               workstation type
Pint              length;             length of application list
Pint              start;              starting position
Pint              * error_ind;        OUT error indicator
Pcolr_map_facs    * colr_map_facs;    OUT colour mapping facilities
Pint              * total_length;     OUT total length of list

FORTRAN Syntax

SUBROUTINE pqcmf ( WTYPE, N, ERRIND, NMETH, METH, NPI )

INTEGER      WTYPE       workstation type
INTEGER      N           element of list of available colour mapping methods
INTEGER      ERRIND      OUT error indicator
INTEGER      NMETH       OUT number of available colour mapping methods
INTEGER      METH        OUT Nth available colour mapping method
INTEGER      NPI         OUT number of predefined indices

Required PHIGS Operating States

(PHOP, * ,* ,* )

DESCRIPTION

Purpose

INQUIRE COLOUR MAPPING FACILITIES returns the available colour mapping facilities for a specified workstation type.

C Input Parameter

type

The workstation type.

length

The number of Pint entries in the array the application has allocated and assigned to colr_map_facs.methods.ints. If zero is specified, then the list of available colour mapping methods is not returned, but the number of available colour mapping methods is returned in the total_length argument.

start

Starting position of inquiry. The elements in the list, beginning with the item number specified by start, are copied sequentially into colr_map_facs.methods.ints until colr_maps_facs.methods.ints is full or all the elements have been copied.

C Output Parameters

error_ind

A pointer to the location to store the error number of any error detected by this function.

colr_map_facs

A pointer to the variable in which to store the colour mapping facilities. Pcolr_map_facs is defined in phigs.h as:

typedef struct {

Pint_list

meths;

/* available colour mapping

methods * /

Pint

num_pred_inds;

/* number of predefined

indices * /

} Pcolr_map_facs;

meths returns the number and list of available colour mapping methods for the specified workstation type. Pint_list is defined in phigs.h as follows:

num_pred_ind returns the number of predefined colour mapping representations.

typedef struct {

Pint            num_ints;           /* number of Pints in list * /
Pint            * ints;             /* list of integers * /

} Pint_list;

The num_ints component specifies the number of elements in the list. The ints component is a pointer to a list num_ints long.

The application must allocate memory for length elements in the list of ints.

The predefined colour mapping methods in phigs.h are:

1   PCOLR_MAP_TRUE
2   PCOLR_MAP_PSEUDO
3   PCOLR_MAP_PSEUDO_N

total_length

A pointer to the integer in which to return the length of the list. This is the value required for length if all the items in the list are to be returned.

FORTRAN Input Parameters

WTYPE Workstation type

N

Index of the desired element from the list of available colour mapping methods for this workstation type. A value of 0 can be used without error to inquire for the number of available colour mapping methods.

FORTRAN Output Parameters

ERRIND

The error number of any error detected by this function.

NMETH

The total length of the list of available colour mapping methods for this workstation type.

METH

The Nth available colour mapping method.

NPI

The number of predefined colour mapping representations.

Execution

If the inquired information is available, the error indicator is returned as zero and values are returned in the output parameters.

If the inquired information is not available, then the values returned in the output parameters are undefined, and the error indicator is set to one of the following error numbers to indicate the reason for nonavailability.

Since this is an inquiry function, ERROR HANDLING (3P) is not invoked when an error is detected by this function.

Errors

002

Ignoring function, function requires state (PHOP, * , * , * )

051

Ignoring function, this information is not yet available for this generic workstation type; open a workstation of this type and use the specific workstation type

052

Ignoring function, workstation type not recognized by the implementation

059

Ignoring function, the specified workstation does not have output capability (that is, the workstation category is not OUTPUT, OUTIN, or MO)

062

Ignoring function, this information is not available for this MO workstation type

SEE ALSO

SET COLOUR MAPPING REPRESENTATION (3PP)

SET COLOUR MAPPING INDEX (3PP)