PEXSetElementPtrAtPickID - Set Structure Element Pointer at Pick ID (5.2)


Synopsis

 
   void PEXSetElementPtrAtPickID(
        Display *display,
        PEXStructure structure,
        long pick_id,
        long offset
   )
 

Arguments

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

structure
The resource identifier of the structure.

pick_id
The value of the pick identifier.

offset
The offset from the pick identifier.

Returns

None.

Description

Invoke PEXSetElementPtrAtPickID to set the element pointer for the specified structure at a position denoted by the pick_id.

A search is conducted for the next occurrence of a pick identifier structure element with the specified pick_id, starting at the current element pointer position plus one and proceeding in the forward direction. The search is non-descending, that is, it does not include any structures referenced by structure. If the pick_id element is found, then the element pointer for the structure is set to the location of the pick_id element plus offset, which may be negative, zero, or positive. If the computed position is less than zero, then the element pointer is set to 0. If the computed position is beyond that of the last element in the structure, then the element pointer is set to the position of the last element in the structure. If the pick_id element is not found, then the implementation issues a BadPEXPickID error and the function leaves the structure's element pointer unchanged.

Errors

BadPEXPickID
The specified pick ID does not exist.

BadPEXStructure
The specified structure resource identifier is invalid.

BadPEXStructurePermission
The structure's permission is PEXStructureLocked.

See Also

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