1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 7.0.1.0 for Windows">
6<META http-equiv="Content-Style-Type" content="text/css">
7<TITLE>ENV_SearchByClass</TITLE>
8<LINK rel="stylesheet" href="../css/nitro.css" type="text/css">
9</HEAD>
10<BODY>
11<H1 align="left">ENV_SearchByClass <img src="../image/NTR.gif"align="middle"><img src="../image/TWL.gif" align="middle"></H1>
12<H2>Syntax</H2>
13<DL>
14  <DD>
15  <PRE><CODE>#include &lt;nitro/env.h&gt;</CODE></PRE>
16  <PRE><CODE>ENVResource* ENV_SearchByClass(
17             ENVResourceIter*   iter,
18             const char*        className );
19  </CODE></PRE>
20</DL>
21<H2>Arguments</H2>
22<TABLE border="1">
23  <TBODY>
24    <TR>
25<TD><SPAN class="argument">iter</SPAN></TD>
26<TD>Resource iterator</TD>
27    </TR>
28    <TR>
29<TD><SPAN class="argument">className</SPAN></TD>
30<TD>Class name to search for</TD>
31    </TR>
32  </TBODY>
33</TABLE>
34<H2>Return Values</H2>
35<P>Returns a pointer to the resource if it was obtainable. If the pointer is unobtainable, it returns <CODE>NULL</CODE>.</P>
36<H2>Description</H2>
37<P>Searches for and gets a resource that has a designated class name.</P>
38<P>Be sure to prepare a resource iterator in advance and initialize it with <A href="ENV_InitIter.html"><CODE>ENV_InitIter</CODE></A>. By continuously searching with this iterator, you can successively get resources that match the conditions.</P>
39<P><B>Example:</B><BR>
40Following is an example of getting the resource with the specific class <CODE>className</CODE>.</P>
41<BLOCKQUOTE style="background-color:#ffffcc"><PRE><FONT color=#ff0033>ENVResourceIter  iter;</FONT>
42ENVResource*    p;
43
44<FONT color=#ff0033>ENV_InitIter( &amp;iter );</FONT>
45while( (p = <FONT color=#ff0033>ENV_SearchByClass( &amp;iter, &quot;className&quot; )</FONT> ) )
46{
47   OS_Printf( &quot;resource = %s\n&quot;, p-&gt;name );
48}</PRE></BLOCKQUOTE>
49
50<H2>See Also</H2>
51<P><A href="ENV_Init.html"><CODE>ENV_Init</CODE></A><BR>
52 <A href="ENV_InitIter.html"><CODE>ENV_InitIter</CODE></A><BR>
53 <A href="ENV_SearchByMember.html"><CODE>ENV_SearchByMember</CODE></A><BR>
54 <A href="ENV_SearchByType.html"><CODE>ENV_SearchByType</CODE></A><BR>
55 <A href="ENV_SearchByPartialName.html"><CODE>ENV_SearchByPartialName</CODE></A><BR>
56 <A href="ENV_GetLastResourceSetFromIter.html"><CODE>ENV_GetLastResourceSetFromIter</CODE></A></P>
57<H2>Revision History</H2>
58<P>2005/08/18 Initial version.</P>
59<hr><p>CONFIDENTIAL</p></body>
60</HTML>
61