IPI_UnloadImage()

This subprocedure is used to unload an image that was previously loaded using IPI_LoadImage(). This should be called to free memory associated with the loaded image prior to calling IPI_Terminate().

Subprocedure Prototype

D IPI_UnloadImage...
D                 PR              N   Extproc('IPI_UnloadImage')

Returns *OFF if an error occurs during processing, *ON otherwise.

 
D  pImageDS                           LikeDS(IPI_ImageDS_t)

Contains image data previously loaded by IPI_LoadImage()

 
D  pErrorDS                           LikeDS(IPI_ErrorDS_t)
D                                     Options(*Nopass:*Omit)

Optional parameter that, if passed, will contain error data returned from the subprocedure. If it is not passed, exceptions will instead be "thrown" and must be caught by a MONITOR block.

Data Structures

D IPI_ImageDS_t   DS                  Qualified Template Inz
  
D  Format                       20A   Varying

Internal use only

 
D  Bytes                        10U 0 Inz(0)

Internal use only

 
D  Width                        10U 0 Inz(0)

Internal use only

 
D  Height                       10U 0 Inz(0)

Internal use only

 
D  Image                          *   Inz(*Null)

Internal use only

 
D  ImageInfo                      *   Inz(*Null)

Internal use only

 
D IPI_ErrorDS_t   DS                  Qualified Template Inz
  
D  Subproc                     132A   Varying

Name of the subprocedure that encountered an error.

 
D  MessageId                     7A

Message ID corresponding to the error that occurred.

 
D  Message                    1024A   Varying

Error message text providing details about the error.