astGetRegionFrameSetastGetRegionFrameSet - Obtain a pointer to the encapsulated FrameSet within a Region

Description:
This function returns a pointer to the FrameSetFrameSet encapsulated by a RegionRegion. The base FrameFrame is the Frame in which the box was originally defined, and the current Frame is the Frame into which the Region is currently mapped (i.e. it will be the same as the Frame returned by astGetRegionFrameastGetRegionFrame).
Synopsis:
AstFrame $*$astGetRegionFrameSet( AstRegion $*$this )
Parameters:
this
Pointer to the Region.
Returned Value:
astGetRegionFrameSet()
A pointer to a deep copy of the FrameSet represented by the Region. Using this pointer to modify the FrameSet will have no effect on the Region.
Notes:
  • A null ObjectObject pointer (AST__NULL) will be returned if this function is invoked with the AST error status set, or if it should fail for any reason.