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_GPISEGEDITING
 
BOOL GpiSetElementPointerAtLabel(hps, idLabel)
HPS hps;         /* presentation-space handle */
LONG idLabel;    /* label identifier          */
 
The GpiSetElementPointerAtLabel function moves the element pointer to the
element containing the specified label. The function starts the search at
the next element after the current element-pointer position. If the function
does not find the label before reaching the end of the segment, the function
leaves the element pointer unchanged and returns an error.
 
The function can be used only in an open segment and only with DM_RETAIN
drawing mode. The function cannot be used in an element bracket.
 
Parameter  Description
────────────────────────────────────────────────────────────────────────────
 
hps        Identifies the presentation space.
 
idLabel    Specifies the label.
 
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_INV_HPS
     PMERR_INV_IN_ELEMENT
     PMERR_INV_MICROPS_FUNCTION
     PMERR_LABEL_NOT_FOUND
     PMERR_NO_CURRENT_GRAPHICS_SEG
     PMERR_NOT_IN_RETAIN_MODE
     PMERR_PS_BUSY
 
See Also
 
GpiLabel, GpiQueryElementPointer, WinGetLastError
 
                                      ♦