symlib.html

vxworks相关论文

<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

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

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS symRemove
    (
    SYMTAB_ID symTblId, /* symbol tbl to remove symbol from */
    char *    name,     /* name of symbol to remove */
    SYM_TYPE  type      /* type of symbol to remove */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine removes a symbol of matching name and type from a
specified 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="./symLib.html#top">symLib</a></b>

<hr>
<a name="symFindByName"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

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

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS symFindByName
    (
    SYMTAB_ID  symTblId, /* ID of symbol table to look in */
    char *     name,     /* symbol name to look for */
    char *     *pValue,  /* where to put symbol value */
    SYM_TYPE * pType     /* where to put symbol type */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine searches a 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>
To search the global VxWorks symbol table, specify <b>sysSymTbl</b>
as <i>symTblId</i>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, or ERROR if the symbol table ID is invalid
or the symbol cannot be found.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./symLib.html#top">symLib</a></b>

<hr>
<a name="symFindByNameAndType"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

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

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS symFindByNameAndType
    (
    SYMTAB_ID  symTblId, /* ID of symbol table to look in */
    char *     name,     /* symbol name to look for */
    char *     *pValue,  /* where to put symbol value */
    SYM_TYPE * pType,    /* where to put symbol type */
    SYM_TYPE   sType,    /* symbol type to look for */
    SYM_TYPE   mask      /* bits in <i>sType</i> to pay attention to */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine searches a symbol table for a symbol matching both name and
type (<i>name</i> and <i>sType</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>
To search the global VxWorks symbol table, specify <b>sysSymTbl</b>
as <i>symTblId</i>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, or ERROR if the symbol table ID is invalid
or the symbol is not found.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./symLib.html#top">symLib</a></b>

<hr>
<a name="symFindByValue"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

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

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS symFindByValue
    (
    SYMTAB_ID  symTblId, /* ID of symbol table to look in */
    UINT       value,    /* value of symbol to find */
    char *     name,     /* where to put symbol name string */
    int *      pValue,   /* where to put symbol value */
    SYM_TYPE * pType     /* where to put symbol type */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine searches a 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>
For the <i>name</i> buffer, allocate <b>MAX_SYS_SYM_LEN</b> + 1 bytes.  The value
<b>MAX_SYS_SYM_LEN</b> is defined in <b>sysSymTbl.h</b>.
<p>
To search the global VxWorks symbol table, specify <b>sysSymTbl</b>
as <i>symTblId</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="./symLib.html#top">symLib</a></b>

<hr>
<a name="symFindByValueAndType"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

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

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS symFindByValueAndType
    (
    SYMTAB_ID  symTblId, /* ID of symbol table to look in */
    UINT       value,    /* value of symbol to find */
    char *     name,     /* where to put symbol name string */
    int *      pValue,   /* where to put symbol value */
    SYM_TYPE * pType,    /* where to put symbol type */
    SYM_TYPE   sType,    /* symbol type to look for */
    SYM_TYPE   mask      /* bits in <i>sType</i> to pay attention to */
    )</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>sType</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>
For the <i>name</i> buffer, allocate <b>MAX_SYS_SYM_LEN</b> + 1 bytes.  The value
<b>MAX_SYS_SYM_LEN</b> is defined in <b>sysSymTbl.h</b>.
<p>
To search the global VxWorks symbol table, specify <b>sysSymTbl</b>
as <i>symTblId</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="./symLib.html#top">symLib</a></b>

<hr>
<a name="symEach"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

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

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>SYMBOL *symEach
    (
    SYMTAB_ID symTblId,  /* pointer to symbol table */
    FUNCPTR   routine,   /* func to call for each tbl entry */
    int       routineArg /* arbitrary user-supplied arg */
    )</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 should be declared as follows:
<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 should return TRUE if <b><i><a href="./symLib.html#symEach">symEach</a></i>(&nbsp;)</b> is to continue
calling it for each entry, or FALSE if it is done and <b><i><a href="./symLib.html#symEach">symEach</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.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./symLib.html#top">symLib</a></b>

</body>
</html>