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_GPICORRELATION
 
BOOL GpiQueryTag(hps, plTag)
HPS hps;        /* presentation-space handle */
PLONG plTag;    /* tag identifier            */
 
The GpiQueryTag function retrieves the current value of the tag identifier,
as set by the GpiSetTag function. The function cannot be used in an open
segment when the drawing mode is DM_RETAIN.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
plTag      Points to the variable to receive the tag.
 
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
the following:
 
     PMERR_INV_HPS
     PMERR_INV_MICROPS_FUNCTION
     PMERR_PS_BUSY
 
See Also
 
GpiSetDrawingMode, GpiSetTag, WinGetLastError
 
                                      ♦