AST_GETREGIONFRAME

Obtain a pointer to the encapsulated Frame within a Region

Description:

This function returns a pointer to the Frame represented by a Region.

Invocation

RESULT = AST_GETREGIONFRAME( THIS, STATUS )

Arguments

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

Returned Value

AST_GETREGIONFRAME = INTEGER
A pointer to a deep copy of the Frame represented by the Region. Using this pointer to modify the Frame will have no effect on the Region. To modify the Region, use the Region pointer directly.

Notes: