[Previous] [Contents] [Index] [Next]

PhQuerySystemInfo()

Query the system for information about a given region

Synopsis:

PhSysInfo_t * PhQuerySystemInfo( 
                  PhRid_t rid,
                  PhRect_t const *rect,
                  PhSysInfo_t *sysinfo );

Description:

This function queries the system for information for the region with the given rid:

The information is stored in the buffer pointed to by sysinfo. Photon reports information about itself and system regions that intersect the rectangular area specified by rect. If rect is NULL, the area is the extent of the given region.

Returns:

A pointer to the PhSysInfo_t structure passed to the function, or NULL if an error occurred.

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PtQuerySystemInfo()

For a description of PhSysInfo_t and the information it provides, see PhT.h and "System information" in the Regions chapter of the Programmer's Guide.


[Previous] [Contents] [Index] [Next]