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_GPISEGMENTS
 
LONG GpiQuerySegmentAttrs(hps, idSegment, lAttribute)
HPS hps;            /* presentation-space handle */
LONG idSegment;     /* segment identifier        */
LONG lAttribute;    /* attribute                 */
 
The GpiQuerySegmentAttrs function checks a segment for the specified
attribute. The function returns ATTR_ON or ATTR_OFF to specify whether the
segment has or does not have the given attribute. The function can be used
to check the attributes of any segment, including the currently open segment
(if any).
 
Parameter   Description
────────────────────────────────────────────────────────────────────────────
 
hps         Identifies the presentation space.
 
idSegment   Specifies the segment identifier. It must be greater than zero.
 
lAttribute  Specifies the attribute to check. It must be one of the
            following values:
 
            Value                 Meaning
            ────────────────────────────────────────────────────────────────
            ATTR_CHAINED          Chained
 
            ATTR_DETECTABLE       Detectability
 
            ATTR_DYNAMIC          Dynamic
 
            ATTR_FASTCHAIN        Fast chaining
 
            ATTR_PROP_DETECTABLE  Propagate detectability
 
            ATTR_PROP_VISIBLE     Propagate visibility
 
            ATTR_VISIBLE          Visibility
 
Return Value
 
The return is ATTR_ON or ATTR_OFF if the function is successful, or
ATTR_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_DRAW_MODE
     PMERR_INV_MICROPS_FUNCTION
     PMERR_INV_SEG_ATTR
     PMERR_INV_SEG_NAME
     PMERR_PS_BUSY
     PMERR_SEG_NOT_FOUND
 
See Also
 
GpiSetSegmentAttrs, WinGetLastError
 
                                      ♦