PhQueryRids

Gamma/Photon: Using Gamma™ with the Photon microGUIŽ, Version 4.0
Prev |  | Next

# `PhQueryRids`

`PhQueryRids` -- finds selected regions.

## Syntax

    PhQueryRids (flags, rid, input_group, type, sense, emitter, rect, maxrids)

## Arguments

`flags`

  Options: ridquery_ig_pointer, ridquery_toward.

`rid`

  A region id number.

`input_group`

  An input group number.

`type`

  A region type.

`sense`

  An event type.

`emitter`

  The region from which the query originates.

`rect`

  A PtRect.

`maxrids`

  The maximum number of region ids to return.

## Returns

The number of regions found, or -1 on error.

## Description

This function finds all the regions that meet the specified criteria. Only those regions that satisfy criteria of the `flag`, `rid`, `input_group`, `type`, and `sense`, and also intersect the area of `rect`, are included.

## See Also

In Photon documentation: PhQueryRids.

Prev | Home | Next
`PhMoveCursor` | Up | `PhRegionChange`

Copyright 1995-2002 by Cogent Real-Time Systems, Inc.