CAT_CINQ - Inquire the values of all the attributes for a column

Description:

Inquire the values of all the attributes for a column. Type conversions are performed if necessary. If the conversion fails a status is set (this is only likely to be important for null values). Note that the exception value is forced into type character in order to avoid having a family of routines. Note also that the genus attribute is returned explicitly.

Invocation:

CALL CAT_CINQ (FI, SZDIM; CI, FNAME, GENUS, EXPR, DTYPE, CSIZE, DIMS, SIZEA, NULL, EXCEPT, SCALEF, ZEROP, ORDER, UNITS, EXTFMT, PRFDSP, COMM, DATE; STATUS)

Arguments:

FI = INTEGER (Given)

Identifier to the column.

SZDIM = INTEGER (Given)

Maximum permitted dimensionality for a column (defines the size of array SIZEA).

CI = INTEGER (Returned)

Catalogue identifier.

FNAME = CHARACTER$*$($*$) (Returned)

Name of the column (or field).

GENUS = INTEGER (Returned)

The genus of the column, coded as follows: CAT__GVIRT - virtual column, CAT__GPHYS - physical column.

EXPR = CHARACTER$*$($*$) (Returned)

The expression defining a virtual column; blank for a physical column.

DTYPE = INTEGER (Returned)

Type of the column. The permitted types are identical to HDS types.

CSIZE = INTEGER (Returned)

Size of a character column. If the column is not of type character CSIZE is set to zero.

DIMS = INTEGER (Returned)

Dimensionality of the column. For a scalar DIMS = 0.

SIZEA(SZDIM) = INTEGER (Returned)

The size of the array in each of its dimensions. The exception is a scalar column, when SIZEA becomes a single-element, one-dimensional array, set to 0.

NULL = INTEGER (Returned)

The way that null values are handled for the column. The permitted values are: CAT__NULLD - default, HDS null values used, CAT__NULLS - null values explicitly specified for the column, CAT__LOCUM - null values not supported for the column and a locum value used instead.

EXCEPT = CHARACTER$*$($*$) (Returned)

In the cases where either the column supports explicitly specified null values, or nulls are not supported and a locum is used instead, EXCEPT contains the required value, written into a character string.

SCALEF = DOUBLE PRECISION (Returned)

Scale factor for scaled columns. 0.0D0 for columns which are not scaled.

ZEROP = DOUBLE PRECISION (Returned)

Zero point for scaled columns. 0.0D0 for columns which are not scaled.

ORDER = INTEGER (Returned)

The order in which values occur in the column, coded as follows: CAT__ASCND - ascending, CAT__DSCND - descending, CAT__NOORD - none.

UNITS = CHARACTER$*$($*$) (Returned)

The units of the column.

EXTFMT = CHARACTER$*$($*$) (Returned)

The external format for the column.

PRFDSP = LOGICAL (Returned)

The preferential display flag for the column: .TRUE. - display the column by default, .FALSE. - do not display the column by default.

COMM = CHARACTER$*$($*$) (Returned)

Comments about the column.

DATE = DOUBLE PRECISION (Returned)

The modification date of the column.

STATUS = INTEGER (Given and Returned)

The global status.

Copyright

Copyright (C) 1999 Central Laboratory of the Research Councils

Bugs:

None known