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.

◄Function Group►  ◄Overview►                          ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_GPIBITMAPS
 
BOOL GpiSetBitmapId(hps, hbm, lcid)
HPS hps;        /* presentation-space handle */
HBITMAP hbm;    /* bitmap handle             */
LONG lcid;      /* local identifier          */
 
The GpiSetBitmapId function tags the bitmap with the local identifier
specified by lcid. The tagged bitmap can subsequently be used for area
shading by specifying the local identifier in a call to the
GpiSetPatternSet function. The bitmap must have a format supported by the
device associated with the presentation space, and it must not be set in any
other device.
 
The GpiDeleteSetId function can subsequently be used to release the
identifier.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
hbm        Identifies the bitmap to tag.
 
lcid       Specifies the local identifier for the bitmap. It can be any
           integer in the range 1 through 254 that has not already been used
           as a bitmap tag or local identifier for a logical font.
 
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_BITMAP_IN_USE
     PMERR_INV_HBITMAP
     PMERR_INV_HPS
     PMERR_INV_SETID
     PMERR_PS_BUSY
     PMERR_SETID_IN_USE
 
See Also
 
GpiBitBlt, GpiDeleteSetId, GpiSetBitmap, GpiSetPatternSet, WinGetLastError
 
                                      ♦