PEXGetStructureInfo(3) — Subroutines

Name

PEXGetStructureInfo - Get Structure Information

Synopsis

Status PEXGetStructureInfo(Display ∗display, PEXStructure structure, int float_format, unsigned long value_mask, PEXStructureInfo ∗info_return)

Arguments

displayA pointer to a display structure returned by a successful XOpenDisplay call.

structureThe resource identifier of the structure.

float_formatThe floating point format to use when computing element sizes (PEXIEEE_754_32, PEXDEC_F_Floating, PEXIEEE_754_64, PEXDEC_D_Floating).

value_maskA mask indicating which values to return.

info_returnReturns information about the structure resource.

Returns

Zero if unsuccessful, non-zero otherwise.

Description

This function returns information about the specified structure resource. The value mask is constructed by or’ing together the following constants:

PEXElementPtr
PEXNumElements
PEXLengthStructure
PEXHasRefs
PEXEditMode

The length of the structure is given in the number of 4-byte units, and is based upon the specified floating point format.

Data Structures

typedef XID             PEXStructure;
typedef struct {
    unsigned long       element_count;
    unsigned long       size;
    Bool                has_refs;
    unsigned short      edit_mode;
    unsigned long       element_pointer;
} PEXStructureInfo;

Errors

BadPEXFloatingPointFormat
The specified floating point format is invalid or unsupported.

BadPEXStructure
The specified structure resource identifier is invalid.

BadValueAn invalid bit is set in the value mask.

Museum