ENV_GetBelongingResourceSet

C Specification

#include <nitro/env.h>
ENVResource* ENV_GetBelongingResourceSet( ENVResourceIter* res );
  

Arguments

res Pointer to the resource

Return Values

A pointer to the resource array which the resource belongs to.

Returns NULL if the resource does not belong to any registered resource array.

Description

Gets a pointer to the resource array which the resource belongs to.

Within the system there may be cases where multiple resource arrays are registered. When obtaining the resource value using ENV_Get*(), etc., this can be performed on multiple resources without noticing. If you want to perform a strict check against the resource arrays, use ENV_GetBelongingResourceSet().

When identical items are in multiple resource arrays, the first item found in search of the list from the front is selected. If the resource does not belong to any array, the return value is NULL.

See Also

ENV_Init, ENV_Get*

Revision History

08/29/2005 Initial version.