This subprocedure is used to load an image from either a character field or a STMF. The loaded image can then be used to perform other IPI operations such as IPI_ImageToPageSegment().
Images can be loaded from:
- A provided RPG field in the pImageData parameter.
- A STMF specified on the Stmf subfield of the IPI_LoadImageDS_t parameter
Many times an image may be Base64 encoded such as if it was received via a web service. IPI_LoadImage() can decode a Base64 encoded image and then proceed to load it if the Base64Encoded subfield of the IPI_LoadImageDS_t parameter is set to IPI_YES. If the image is not Base64 encoded, this subfield should be set to IPI_NO.
Once the image has been loaded, an IPI_ImageDS_t data structure will be returned. This is used to provide important information about the image to other IPI subprocedures.