📄 snmpebuflib.html
字号:
<html><head><!-- /vobs/wpwr/docs/vxworks/ref/snmpEbufLib.html - generated by refgen from snmpEbufLib.c --> <title> snmpEbufLib </title></head><body bgcolor="#FFFFFF"> <hr><a name="top"></a><p align=right><a href="libIndex.html"><i>VxWorks Reference Manual : Libraries</i></a></p></blockquote><h1>snmpEbufLib</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>snmpEbufLib</strong> - extended-buffer manipulation functions </p></blockquote><h4>ROUTINES</h4><blockquote><p><p><b><i><a href="./snmpEbufLib.html#EBufferClone">EBufferClone</a></i>( )</b> - make a copy of an extended buffer <br><b><i><a href="./snmpEbufLib.html#EBufferClean">EBufferClean</a></i>( )</b> - release dynamic memory in an extended buffer<br><b><i><a href="./snmpEbufLib.html#EBufferInitialize">EBufferInitialize</a></i>( )</b> - place an extended buffer in a known state<br><b><i><a href="./snmpEbufLib.html#EBufferSetup">EBufferSetup</a></i>( )</b> - attach an empty memory buffer to an extended buffer<br><b><i><a href="./snmpEbufLib.html#EBufferPreLoad">EBufferPreLoad</a></i>( )</b> - attach a full memory buffer to an extended buffer<br><b><i><a href="./snmpEbufLib.html#EBufferNext">EBufferNext</a></i>( )</b> - return a pointer to the next unused byte of the buffer memory<br><b><i><a href="./snmpEbufLib.html#EBufferStart">EBufferStart</a></i>( )</b> - return a pointer to the first byte in the buffer memory<br><b><i><a href="./snmpEbufLib.html#EBufferUsed">EBufferUsed</a></i>( )</b> - return the number of used bytes in the buffer memory<br><b><i><a href="./snmpEbufLib.html#EBufferReset">EBufferReset</a></i>( )</b> - reset the extended buffer<br><b><i><a href="./snmpEbufLib.html#EBufferRemaining">EBufferRemaining</a></i>( )</b> - return the number of unused bytes remaining in buffer memory<br><p></blockquote><h4>DESCRIPTION</h4><blockquote><p><p>This module defines the routines used to manipulate extended buffers.<p></blockquote><h4>INCLUDE FILES</h4><blockquote><p><b>buffer.h</b><p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b><hr><a name="EBufferClone"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>EBufferClone</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>EBufferClone</i>( )</strong> - make a copy of an extended buffer </p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>int EBufferClone ( EBUFFER_T * srcp, /* source buffer */ EBUFFER_T * dstp /* destination buffer */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine creates a copy of an extended buffer, allocating space from thedynamic pool. Parameter <i>srcp</i> is the old buffer, and <i>dstp</i> the new.<p></blockquote><h4>RETURNS</h4><blockquote><p>0 if successful, otherwise -1.</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b><hr><a name="EBufferClean"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>EBufferClean</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>EBufferClean</i>( )</strong> - release dynamic memory in an extended buffer</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void EBufferClean ( EBUFFER_T * ebuffp /* extended buffer */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine releases any dynamic memory attached to <i>ebuffp</i><p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b><hr><a name="EBufferInitialize"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>EBufferInitialize</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>EBufferInitialize</i>( )</strong> - place an extended buffer in a known state</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void EBufferInitialize ( EBUFFER_T * ebuffp /* extended buffer */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine places the buffer-control block in a known state. The bufferis not ready to accept data, but may be safely handled by the extended-buffer routines.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b><hr><a name="EBufferSetup"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>EBufferSetup</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>EBufferSetup</i>( )</strong> - attach an empty memory buffer to an extended buffer</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void EBufferSetup ( unsigned int flags, /* storage type flags */ EBUFFER_T * ebuffp, /* extended buffer */ OCTET_T * datap, /* data pointer */ ALENGTH_T datal /* data length */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine attaches an empty memory buffer to a buffer-control block.<p><i>flags</i> should be set to the manifest constant <b>BFL_IS_DYNAMIC</b> if the bufferhas been allocated from the dynamic pool. Otherwise, <i>flags</i> should be setto <b>BFL_IS_STATIC</b>. The location and length of the buffer are describedby <i>datap</i> and <i>datal</i>, respectively.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b><hr><a name="EBufferPreLoad"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>EBufferPreLoad</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>EBufferPreLoad</i>( )</strong> - attach a full memory buffer to an extended buffer</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void EBufferPreLoad ( unsigned int flags, /* storage type flags */ EBUFFER_T * ebuffp, /* extended buffer */ OCTET_T * datap, /* data pointer */ ALENGTH_T datal /* data length */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine attaches a full memory buffer to a buffer-control block. Use this routine when constructing a parameter for a procedure whichrequires buffers in the extended-buffer format.<p><i>flags</i> should be set to the manifest constant <b>BFL_IS_DYNAMIC</b> if thebuffer has been allocated from the dynamic pool. Otherwise, <i>flags</i>should be set to <b>BFL_IS_STATIC</b>. The location and length of the buffer aredescribed by <i>datap</i> and <i>datal</i>, respectively.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b><hr><a name="EBufferNext"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>EBufferNext</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>EBufferNext</i>( )</strong> - return a pointer to the next unused byte of the buffer memory</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>OCTET_T * EBufferNext ( EBUFFER_T * ebuffp /* extended buffer */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine returns a pointer to the next unused byte in the buffer memory.The pointer is valid only if there are unused bytes remaining in the buffer.<p></blockquote><h4>RETURNS</h4><blockquote><p>a pointer to the first unused byte.</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b><hr><a name="EBufferStart"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>EBufferStart</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>EBufferStart</i>( )</strong> - return a pointer to the first byte in the buffer memory</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>OCTET_T * EBufferStart ( EBUFFER_T * ebuffp /* extended buffer */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine returns a pointer to the first byte in the buffer memory.<p></blockquote><h4>RETURNS</h4><blockquote><p>a pointer to the first memory byte.</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b><hr><a name="EBufferUsed"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>EBufferUsed</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>EBufferUsed</i>( )</strong> - return the number of used bytes in the buffer memory</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>ALENGTH_T EBufferUsed ( EBUFFER_T * ebuffp /* extended buffer */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine returns the number of used bytes currently in the buffer.<p></blockquote><h4>RETURNS</h4><blockquote><p>the number of used bytes.</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b><hr><a name="EBufferReset"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>EBufferReset</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>EBufferReset</i>( )</strong> - reset the extended buffer</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void EBufferReset ( EBUFFER_T * ebuffp /* extended buffer */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine sets the various pointers and counters so that thebuffer is exactly as it would be after a call to <b><i><a href="./snmpEbufLib.html#EBufferSetup">EBufferSetup</a></i>( )</b>.The memory buffer itself is left unchanged.<p></blockquote><h4>RETURNS</h4><blockquote><p>N/A</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b><hr><a name="EBufferRemaining"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>EBufferRemaining</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>EBufferRemaining</i>( )</strong> - return the number of unused bytes remaining in buffer memory</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void EBufferRemaining ( EBUFFER_T * ebuffp /* extended buffer */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine returns the number of unused bytes remaining in theextended buffer memory.<p></blockquote><h4>RETURNS</h4><blockquote><p>the number of unused bytes.</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./snmpEbufLib.html#top">snmpEbufLib</a></b></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -