PhRegionGetData()

Get the data of a given type associated with a region

Synopsis:

PhRegionDataHdr_t *PhRegionGetData(
                      PhRid_t rid,
                      short type,
                      PhRegionDataHdr_t *buf,
                      size_t len );

Library:

ph

Description:

This function looks for region data block matching the specified type, associated with the region rid, and returns a copy of up to len bytes in the buffer pointer to by buf. If the specified data type isn't in the region's data list, buf->len is set to zero. Otherwise, buf->len is set to the actual length of the data block (even if it's larger than the len argument to the function).

Returns:

The same pointer as buf, or NULL if an error occurred (e.g. the region doesn't exist).

Errors:

Examples:

Classification:

Photon

See also:

PhRegion_t, PhRegionDataFindType(), PhRegionDataHdr_t, PhRegionQuery()

Regions chapter of the Photon Programmer's Guide