vxwsymtab.html

vxworks相关论文

This routine allocates a symbol <i>name</i> and adds it to its symbol
table with the specified parameters <i>value</i>, <i>type</i>, and <i>group</i>.
The <i>group</i> parameter specifies the group number assigned to a module when
it is loaded on the target; see the manual entry for moduleLib.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, or ERROR if there is insufficient memory for the symbol to be
allocated.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./VXWSymTab.html#top">VXWSymTab</a></b>, <b><a href="./moduleLib.html#top">moduleLib</a></b>

<hr>
<a name="VXWSymTab::each"></a>
<p align=right>
<a href="rtnIndex.html"><i>Wind Foundation Classes :  Methods</i></a></p>

</blockquote><h1><i>VXWSymTab::each</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>VXWSymTab::each</i>(&nbsp;)</strong> - call a routine to examine each entry in a symbol table</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>SYMBOL * each
    (
    FUNCPTR routine,
    int     routineArg
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine calls a user-supplied routine to examine each entry in the
symbol table; it calls the specified routine once for each entry.  The
routine must have the following type signature:
<pre>    BOOL routine
        (
        char *       name,   /* entry name                  */
        int          val,    /* value associated with entry */
        SYM_TYPE     type,   /* entry type                  */
        int          arg,    /* arbitrary user-supplied arg */
        UINT16       group   /* group number                */
        )
</pre>
The user-supplied routine must return TRUE if <b><i><a href="./VXWSymTab.html#VXWSymTab::each">VXWSymTab::each</a></i>(&nbsp;)</b> is to
continue calling it for each entry, or FALSE if it is done and
<b><i><a href="./VXWSymTab.html#VXWSymTab::each">VXWSymTab::each</a></i>(&nbsp;)</b> can exit.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
A pointer to the last symbol reached, or NULL if all symbols are
reached.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./VXWSymTab.html#top">VXWSymTab</a></b>

<hr>
<a name="VXWSymTab::findByName"></a>
<p align=right>
<a href="rtnIndex.html"><i>Wind Foundation Classes :  Methods</i></a></p>

</blockquote><h1><i>VXWSymTab::findByName</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>VXWSymTab::findByName</i>(&nbsp;)</strong> - look up a symbol by name</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS findByName
    (
    char *     name,
    char *     *pValue,
    SYM_TYPE * pType
    ) const</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine searches its symbol table for a symbol matching a specified
name.  If the symbol is found, its value and type are copied to <i>pValue</i>
and <i>pType</i>.  If multiple symbols have the same name but differ in type,
the routine chooses the matching symbol most recently added to the symbol
table.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, or ERROR if the symbol cannot be found.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./VXWSymTab.html#top">VXWSymTab</a></b>

<hr>
<a name="VXWSymTab::findByNameAndType"></a>
<p align=right>
<a href="rtnIndex.html"><i>Wind Foundation Classes :  Methods</i></a></p>

</blockquote><h1><i>VXWSymTab::findByNameAndType</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>VXWSymTab::findByNameAndType</i>(&nbsp;)</strong> - look up a symbol by name and type</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS findByNameAndType
    (
    char *     name,
    char *     *pValue,
    SYM_TYPE * pType,
    SYM_TYPE   goalType,
    SYM_TYPE   mask
    ) const</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine searches its symbol table for a symbol matching both name and
type (<i>name</i> and <i>goalType</i>).  If the symbol is found, its value and type are
copied to <i>pValue</i> and <i>pType</i>.  The <i>mask</i> parameter can be used to match
sub-classes of type.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, or ERROR if the symbol is not found.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./VXWSymTab.html#top">VXWSymTab</a></b>

<hr>
<a name="VXWSymTab::findByValue"></a>
<p align=right>
<a href="rtnIndex.html"><i>Wind Foundation Classes :  Methods</i></a></p>

</blockquote><h1><i>VXWSymTab::findByValue</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>VXWSymTab::findByValue</i>(&nbsp;)</strong> - look up a symbol by value</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS findByValue
    (
    UINT       value,
    char *     name,
    int *      pValue,
    SYM_TYPE * pType
    ) const</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine searches its symbol table for a symbol matching a specified
value.  If there is no matching entry, it chooses the table entry with the
next lower value.  The symbol name (with terminating EOS), the actual
value, and the type are copied to <i>name</i>, <i>pValue</i>, and <i>pType</i>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, or ERROR if <i>value</i> is less than the lowest value in the table.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./VXWSymTab.html#top">VXWSymTab</a></b>

<hr>
<a name="VXWSymTab::findByValueAndType"></a>
<p align=right>
<a href="rtnIndex.html"><i>Wind Foundation Classes :  Methods</i></a></p>

</blockquote><h1><i>VXWSymTab::findByValueAndType</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>VXWSymTab::findByValueAndType</i>(&nbsp;)</strong> - look up a symbol by value and type</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS findByValueAndType
    (
    UINT       value,
    char *     name,
    int *      pValue,
    SYM_TYPE * pType,
    SYM_TYPE   goalType,
    SYM_TYPE   mask
    ) const</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine searches a symbol table for a symbol matching both
value and type (<i>value</i> and <i>goalType</i>).  If there is no matching
entry, it chooses the table entry with the next lower value.  The
symbol name (with terminating EOS), the actual value, and the type
are copied to <i>name</i>, <i>pValue</i>, and <i>pType</i>.  The <i>mask</i> parameter
can be used to match sub-classes of type.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, or ERROR if <i>value</i> is less than the lowest value in the table.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./VXWSymTab.html#top">VXWSymTab</a></b>

<hr>
<a name="VXWSymTab::remove"></a>
<p align=right>
<a href="rtnIndex.html"><i>Wind Foundation Classes :  Methods</i></a></p>

</blockquote><h1><i>VXWSymTab::remove</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>VXWSymTab::remove</i>(&nbsp;)</strong> - remove a symbol from a symbol table</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS remove
    (
    char *   name,
    SYM_TYPE type
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine removes a symbol of matching name and type from
its symbol table.  The symbol is deallocated if found.
Note that VxWorks symbols in a standalone VxWorks image (where the 
symbol table is linked in) cannot be removed.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, or ERROR if the symbol is not found
or could not be deallocated.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./VXWSymTab.html#top">VXWSymTab</a></b>

</body>
</html>