This function searches the suppliedMapping (which may be a compound Mapping such as a CmpMap) for any component Mappings that are instances of the AST Region class. It then creates a new Mapping from which all Regions have been removed. If a Region cannot simply be removed (for instance, if it is a component of a parallel CmpMap), then it is replaced with an equivalent UnitMap in the returned Mapping.

RESULT = AST_REMOVEREGIONS( THIS, STATUS )

THIS = INTEGER (Given)

STATUS = INTEGER (Given and Returned)

CmpFrame

FrameSet

Mapping

Region

AST_REMOVEREGIONS = INTEGER

• This function can safely be applied even to Mappings which contain no Regions. If no Regions are found, it behaves exactly like AST_CLONE and returns a pointer to the original Mapping.

• The Mapping returned by this function may not be independent of the original (even if some Regions were removed), and modifying it may therefore result in indirect modification of the original. If a completely independent result is required, a copy should be made using AST_COPY.

• A null Object pointer (AST__NULL) will be returned if this function is invoked with STATUS set to an error value, or if it should fail for any reason.