OpenGraphicsFolio

Opens the Graphics folio for use by the calling task.

Synopsis

Err OpenGraphicsFolio (void)

Description

OpenGraphicsFolio() issues an OpenItem() call to open the Graphics folio for use by the calling task. If the Graphics folio is successfully opened, this call sets the global variable GrafFolioNum to the item number of the Graphics folio item. It also sets the global variable GrafBase to the pointer to the Graphics folio's GrafFoliostructure. GrafBase must be properly initialized before calling any of the Graphics folio calls.

This call is a convenience call that is provided in the graphics.lib, and is not part of the Graphics folio.

After the Graphics folio is opened, the task can use any of the other Graphics folio calls.

Return Value

The call returns 0 if successful or an error code (a negative value) if an error occurs.

Implementation

Convenience call implemented in graphics.lib V20.

Associated Files