ENV_SearchByClass

Syntax

#include <nitro/env.h>
ENVResource* ENV_SearchByClass(
             ENVResourceIter*   iter,
             const char*        className );
  

Arguments

iter Resource iterator
className Class name to search for

Return Values

Returns a pointer to the resource if it was obtainable. If the pointer is unobtainable, it returns NULL.

Description

Searches for and gets a resource that has a designated class name.

Be sure to prepare a resource iterator in advance and initialize it with ENV_InitIter. By continuously searching with this iterator, you can successively get resources that match the conditions.

Example:
Following is an example of getting the resource with the specific class className.

ENVResourceIter  iter;
ENVResource*    p;

ENV_InitIter( &iter );
while( (p = ENV_SearchByClass( &iter, "className" ) ) )
{
   OS_Printf( "resource = %s\n", p->name );
}

See Also

ENV_Init
ENV_InitIter
ENV_SearchByMember
ENV_SearchByType
ENV_SearchByPartialName
ENV_GetLastResourceSetFromIter

Revision History

2005/08/18 Initial version.


CONFIDENTIAL