AST_GETTABLES

Retrieve any FitsTables currently in a FitsChan

Description:

If the supplied FitsChan currently contains any tables, then this function returns a pointer to a KeyMap. Each entry in the KeyMap is a pointer to a FitsTable holding the data for a FITS binary table. The key used to access each entry is the FITS extension name in which the table should be stored.

Tables can be present in a FitsChan as a result either of using the AST_PUTTABLE (or AST_PUTTABLES) method to store existing tables in the FitsChan, or of using the AST_WRITE method to write a FrameSet to the FitsChan. For the later case, if the FitsChan "TabOK" attribute is positive and the FrameSet requires a look-up table to describe one or more axes, then the " -TAB" algorithm code described in FITS-WCS paper III is used and the table values are stored in the FitsChan in the form of a FitsTable object (see the documentation for the " TabOK" attribute).

Invocation

RESULT = AST_GETTABLES( THIS, STATUS )

Arguments

THIS = INTEGER (Given)
Pointer to the FitsChan.
STATUS = INTEGER (Given and Returned)
The global status.

Returned Value

AST_GETTABLES = INTEGER
A pointer to a deep copy of the KeyMap holding the tables currently in the FitsChan, or AST__NULL if the FitsChan does not contain any tables. The returned pointer should be annulled using AST_ANNUL when no longer needed.

Notes: