PhRegionDataFindType()

Find a data type within a region's data

Synopsis:

PhRegionDataHdr_t * 
    PhRegionDataFindType( 
        PhRegion_t const *region,
        PhRegionDataHdr_t const *data,
        short type);

Library:

ph

Description:

This function finds the specified type of data within the provided region's data block. For a list of types, see the description of PhRegionDataHdr_t.

Returns:

A pointer to a PhRegionDataHdr_t structure that matches the specified data type. If no data entries within the region's data block match the specified type, the function returns NULL.

Examples:

See PhRegionChange().

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PhRegion_t, PhRegionDataHdr_t, PhRegionChange(), PhRegionQuery()

Regions chapter of the Photon Programmer's Guide