gpi12.hlp (Table of Contents; Topic list)
Important Notice
The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.
GpiSaveMetaFile (1.2)
Function Group  Overview                          Up Next Previous
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIMETAFILES
 
BOOL GpiSaveMetaFile(hmf, pszFilename)
HMF hmf;            /* metafile handle     */
PSZ pszFilename;    /* address of filename */
 
The GpiSaveMetaFile function saves a metafile to disk. The function deletes
the metafile from memory and invalidates the metafile handle. The
application can load the metafile by using the GpiLoadMetaFile function.
 
Parameter    Description
────────────────────────────────────────────────────────────────────────────
 
hmf          Identifies the metafile.
 
pszFilename  Points to a null-terminated string. This string must be a valid
             MS OS/2 filename that specifies the path and filename of the
             file to receive the metafile.
 
Return Value
 
The return value is GPI_OK if the function is successful or GPI_ERROR if an
error occurred.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     PMERR_DOSOPEN_FAILURE
     PMERR_INSUFFICIENT_DISK_SPACE
     PMERR_INV_HMF
 
See Also
 
GpiLoadMetaFile, GpiPlayMetaFile