PEXGetStructureInfo - Get Structure Information (5.0)


Synopsis

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

Arguments

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

structure
The resource identifier of the structure.

float_format
The floating-point format to use when computing element sizes (PEXIEEE_754_32, PEXDEC_F_Floating, PEXIEEE_754_64 or PEXDEC_D_Floating).

value_mask
A mask indicating which values to return.

info_return
Returns information about the structure resource.

Returns

Zero if unsuccessful; non-zero otherwise.

Description

Invoke PEXGetStructureInfo to get information about the specified structure resource.

The value_mask is constructed by or'ing together the following constants:

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

If the structure's permission is PEXStructureWriteOnly,then the size member of the PEXStructureInfo structure is an undefined value. If the structure's permission is PEXStructureLocked, then the members of the PEXStructureInfo data structure element_count, size, edit_mode, and element_pointer, have undefined values.

Errors

BadPEXFloatingPointFormat
The specified floating-point format is invalid or unsupported.

BadPEXStructure
The specified structure resource identifier is invalid.

BadValue
An invalid bit is set in the value mask.

See Also

For a list of all Structure functions and related topics, see Structures.