symlib.html

Vxworks API操作系统和驱动程序设计API。压缩的HTML文件

</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.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>symFindByNameAndType(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>symFindByNameAndType(&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="symByValueFind"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

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

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS symByValueFind
    (
    SYMTAB_ID  symTblId,      /* ID of symbol table to look in */
    UINT       value,         /* value of symbol to find */
    char * *   pName,         /* where return 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.  A pointer to a copy of the
symbol name string (with terminating EOS) is returned into
<i>pName</i>. The actual value and the type are copied to <i>pValue</i> and
<i>pType</i>.
<p>
<i>pName</i> is a pointer to memory allocated by symByValueFind; 
the memory must be freed by the caller after the use of <i>pName</i>.
<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>symTblId</i> is invalid, <i>pName</i> is NULL, or
<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="symByValueAndTypeFind"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

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

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS symByValueAndTypeFind
    (
    SYMTAB_ID  symTblId,      /* ID of symbol table to look in */
    UINT       value,         /* value of symbol to find */
    char * *   pName,         /* where to return 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 (among
entries with the same type). A pointer to the symbol name string
(with terminating EOS) is returned into <i>pName</i>. The actual value
and the 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>
<i>pName</i> is a pointer to memory allocated by symByValueAndTypeFind; 
the memory must be freed by the caller after the use of <i>pName</i>.
<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>symTblId</i> is invalid, <i>pName</i> is NULL, or
<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="symFindByValue"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>symFindByValue(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>symFindByValue(&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 is obsolete.  It is replaced by <b><a href="./symLib.html#symByValueFind">symByValueFind</a>(&nbsp;)</b>.
<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>.  If the name of the symbol 
is longer than <b>MAX_SYS_SYM_LEN</b> bytes, it will be truncated to fit into the
buffer.  Whether or not the name was truncated, the string returned in the
buffer will be null-terminated.
<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>symTblId</i> is invalid or <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.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>symFindByValueAndType(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>symFindByValueAndType(&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 is obsolete.  It is replaced by the routine
<b><a href="./symLib.html#symByValueAndTypeFind">symByValueAndTypeFind</a>(&nbsp;)</b>.
<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>.  If the name of the symbol 
is longer than <b>MAX_SYS_SYM_LEN</b> bytes, it will be truncated to fit into the
buffer.  Whether or not the name was truncated, the string returned in the
buffer will be null-terminated.
<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>symTblId</i> is invalid or <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.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>symEach(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>symEach(&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><a href="./symLib.html#symEach">symEach</a>(&nbsp;)</b> is to continue
calling it for each entry, or FALSE if it is done and <b><a href="./symLib.html#symEach">symEach</a>(&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>