GpiQueryTag

This function returns the current value of the tag identifier, as set by the GpiSetTag function.

Syntax

GpiQueryTag(hps, plTag)

Parameters

hps (HPS) - input

Presentation-space handle.

plTag (PLONG) - output

Tag identifier.

Return Value

rc (BOOL) - returns

Success indicator.

TRUE

Successful completion

FALSE

Error occurred.

Remarks

This function is invalid when the drawing mode (see GpiSetDrawingMode) is set to retain.

Errors

Possible returns from WinGetLastError:

PMERR_INV_HPS (0x207F)

An invalid presentation-space handle was specified.

PMERR_PS_BUSY (0x20F4)

An attempt was made to access the presentation space from more than one thread simultaneously.

PMERR_INV_MICROPS_FUNCTION (0x20A1)

An attempt was made to issue a function that is invalid in a micro presentation space.

Example Code

#define INCL_GPICORRELATION /* Or use INCL_GPI, INCL_PM, */
#include <os2.h>

HPS      hps;    /*  Presentation-space handle. */
PLONG    plTag;  /*  Tag identifier. */
BOOL     rc;     /*  Success indicator. */

rc = GpiQueryTag(hps, plTag);

This function returns the current value of the tag identifier, as set by the GpiSetTag call.

#define INCL_GPICORRELATION
#include <OS2.H>

HPS hps; /* Presentation-space handle. */
LONG lTag; /* Tag identifier. */

GpiQueryTag(hps, &lTag);