| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- File List
- File Members

E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/drivers/Oracle/OCI/include/kusapi.h
Go to the documentation of this file.

    00001 /*
    00002  * $Header$
    00003  */
    00004
    00005 /* Copyright (c) Oracle Corporation 1996, 1997. All Rights Reserved. */
    00006
    00007 /* NOTE:  See 'header_template.doc' in the 'doc' dve under the 'forms'
    00008       directory for the header file template that includes instructions.
    00009 */
    00010
    00011 /*
    00012    NAME
    00013      kusapi.h - Kernel Utility Statistics Application Programming Interface
    00014
    00015    DESCRIPTION
    00016      Declarations of types and functions of the API used to retrieve
    00017      statistics from the SGA
    00018
    00019    PUBLIC FUNCTION(S)
    00020      kusdb_connect - connect to a database
    00021      kuscx_allocate - allocate continuation context
    00022      kuscx_free - free continuation context
    00023      kuscx_init - initialize continuation context
    00024      kusdb_get_info - retrieve database information
    00025      kusdb_get_memory - copy SGA contents into user-allocated memory
    00026      kusdb_disconnect - disconnect from database
    00027      kusdb_error_text - format message for last error
    00028      kustv_allocate_handle - allocate a TLV handle
    00029      kustv_dump - dump a TLV buffer
    00030      kustv_free_handle - free a TLV handle
    00031      kustv_get - get next entry in a TLV buffer
    00032      kustv_offset - return offset for current entry in TLV buffer
    00033      kussys_get_info - retrieve non-db-related info (noop for Oracle)
    00034      kussys_error_text - format message for last error (noop for Oracle)
    00035      kustvp1_put_one_byte - put TLV entry with 1 byte value into TLV buffer
    00036      kustvp2_put_two_bytes - put TLV entry with 2 byte value into TLV buffer
    00037      kustvp4_put_four_bytes - put TLV entry with 4 byte value into TLV buffer
    00038      kustv_put - put TLV entry into TLV buffer
    00039      kustvptg_put_tag - put TLV entry with empty value into TLV buffer
    00040      kustv_reinit_handle - reset offset for a TLV handle
    00041      kustv_buffer_state - return termination state for tlv buffer
    00042
    00043    NOTES
    00044      This interface is subject to change without notice
    00045
    00046    MODIFIED   (MM/DD/YY)
    00047    pabingha    03/14/97 - Add get_tagname argument
    00048    jstenois    11/05/96 - "Make kustv_dump() header CONST"
    00049    jstenois    11/01/96 - Use oratypes instead of sx.h
    00050    jstenois    08/15/96 - SGAAPI public include file
    00051    jstenois    08/15/96 - Creation
    00052
    00053 */
    00054
    00055
    00056 #ifndef KUSAPI
    00057 # define KUSAPI
    00058
    00059 # ifndef ORATYPES
    00060 #  include <oratypes.h>
    00061 # endif
    00062
    00063
    00064 /*---------------------------------------------------------------------------
    00065                      PUBLIC TYPES AND CONSTANTS
    00066   ---------------------------------------------------------------------------*/
    00067
    00068 /* values for status code returned by API calls */
    00069
    00070 typedef enum kusst
    00071   {
    00072
    00073     KUSSTOK =                    1,         /* Success                              */
    00074     KUSSTEOB =                   2,         /* Cursor at end of buffer.              */
    00075     KUSSTNWR =                   3,         /* Attempt to write to TLV when no      */
    00076                                             /*    length specified at init time         */
    00077     KUSSTILN =                   4,         /* Invalid length specified when */
    00078                                             /*    passing by value                                 */
    00079     KUSSTTRNC =                  5,         /* buffer was truncated                                */
    00080     KUSSTCONT =                  6,         /* buffer is continued                                 */
    00081     KUSSTALLC =                  7,         /* unable to allocate memory                */
    00082     KUSSTUNKC =                  8,         /* unknown class tag specified              */
    00083     KUSSTICH =                   9,         /* Invalid context handle                   */
    00084     KUSSTIDH =                   10,        /* Invalid database handle                  */
    00085     KUSSTITH =                   11,        /* Invalid TLV handle                       */
    00086     KUSSTDIS =                   12,        /* Stats collection disabled for database */
    00087     KUSSTERR =                   13,        /* Unexpected error encountered             */
    00088     KUSSTBINF =                  14,        /* Input buffer contained a bad tag         */
    00089     KUSSTBDKY =         15,     /* Bad index value for class tag  */
    00090     KUSSTBFSML =      16,        /* Buffer is too small for data             */
    00091     KUSSTIBE =                   17,        /* Information buffer is empty          */
    00092     KUSSTDBDOWN =       18,     /* Database is unavaliable              */
    00093     KUSSTFILACC =       19,     /* File cannot be accessed              */
    00094     KUSSTINVDB =        20,     /* File is not a db root file (Rdb only)*/
    00095     KUSSTNODB =         21,     /* Db root file doesn't exist (Rdb only)*/
    00096     KUSSTBADVER =       22,     /* Db root file wrong version (Rdb only)*/
    00097     KUSSTCIU =          23,     /* Context is already in use            */
    00098     KUSSTDMPOP =        24,     /* Unable to open dump output file      */
    00099     KUSSTDMPCL =        25      /* Unable to close dump output file     */
    00100   } kusst;
    00101
    00102
    00103 /* values returned by kustvstate */
    00104
    00105 typedef enum kustvs
    00106   {
    00107     KUSTVS_CONT =     1,         /* tlv buffer terminated with KUSSTCONT     */
    00108     KUSTVS_END =      2,         /* tlv buffer terminated with KUSSTBEND     */
    00109     KUSTVS_TRUNC =    3,         /* tlv buffer terminated with KUSSTTRNC     */
    00110     KUSTVS_UNK =      4          /* handle specified has not been used       */
    00111                                 /* to read or write a termination tag   */
    00112   } kustvs;
    00113
    00114
    00115 /* Type Definitions for handles */
    00116
    00117 typedef dvoid *kusdb_handle;     /* handle for connected database */
    00118 typedef dvoid *kuscx_handle;     /* handle for continuation context */
    00119 typedef dvoid *kustv_handle;     /* handle for TLV context */
    00120
    00121 /* Data structure for use by kusdb_get_memory */
    00122
    00123 typedef struct kusmem
    00124   {
    00125     ub1 *sga_address_kusmem;    /* SGA memory address */
    00126     ub4 length_kusmem;          /* Number of bytes to copy */
    00127     ub1 *dest_address_kusmem;   /* User-allocated destination for SGA data */
    00128   } kusmem;
    00129
    00130
    00131 /*---------------------------------------------------------------------------
    00132                            PUBLIC FUNCTIONS
    00133   ---------------------------------------------------------------------------*/
    00134
    00135
    00136 /* ---------------------------- kuscx_allocate ----------------------------- */
    00137 /*
    00138   NAME
    00139     kuscx_allocate -  allocate continuation context
    00140   DESCRIPTION
    00141     Allocate space to track information about continuation context for a
    00142     kusdb_get_info call.
    00143   PARAMETERS
    00144     context_handle - handle for the continuation context (in/out)
    00145   RETURN VALUE
    00146     status of call
    00147   NOTES
    00148     kuscx_init can be used to reinitilize a context that has been allocated
    00149     and is no longer used for a TLV buffer
    00150 */
    00151
    00152 kusst kuscx_allocate (/*_ kuscx_handle *context_handle _*/);
    00153
    00154
    00155
    00156
    00157 /* ------------------------------ kuscx_free_handle ------------------------ */
    00158 /*
    00159   NAME
    00160     kuscx_free_handle -  free continuation context
    00161   DESCRIPTION
    00162     free space used to track information about continuation context for a
    00163     kusdb_get_info call.
    00164   PARAMETERS
    00165     context_handle - handle for the continuation context (in/out)
    00166   RETURN VALUE
    00167     status of call
    00168   NOTES
    00169     kuscx_init can be used to reinitilize a context that has been allocated
    00170     and is no longer used for a TLV buffer
    00171 */
    00172
    00173 kusst kuscx_free_handle (/*_ kuscx_handle *context_handle _*/);
    00174
    00175
    00176
    00177
    00178 /* ------------------------------ kuscx_init ------------------------------- */
    00179 /*
    00180   NAME
    00181     kuscx_init -  initialize continuation context
    00182   DESCRIPTION
    00183     Reinitialize a context handle that has been previously allocated and used.
    00184   PARAMETERS
    00185     context_handle - handle for the continuation context (in/out)
    00186   RETURN VALUE
    00187     status of call
    00188   NOTES
    00189     kuscx_init is the semantic equivalent of freeing a context handle and then
    00190     allocating a new one.
    00191 */
    00192
    00193 kusst kuscx_init (/*_ kuscx_handle *context_handle _*/);
    00194
    00195
    00196
    00197 /* ----------------------------- kusdb_allocate ---------------------------- */
    00198 /*
    00199   NAME
    00200     kusdb_allocate - allocate a database handle
    00201   DESCRIPTION
    00202     allocate resources for a database handle
    00203   PARAMETERS
    00204     db_handle - handle for the database context (in/out)
    00205   RETURN VALUE
    00206     kusst - status of attempt to allocate
    00207 */
    00208
    00209 kusst kusdb_allocate (/*_ kusdb_handle *db_handle _*/);
    00210
    00211
    00212
    00213
    00214 /* ----------------------------- kusdb_connect ----------------------------- */
    00215 /*
    00216   NAME
    00217     kusdb_connect - connect to a database
    00218   DESCRIPTION
    00219     Connects to a database so that statistics for that database can be
    00220     retrieved.
    00221   PARAMETERS
    00222     db_handle - handle for the database context (in/out)
    00223     database_name_length - number of bytes in database_name parameter
    00224     database name - name of database
    00225     security_info_length - number of bytes in security_info parameter
    00226     security_info - security information used to attach to database
    00227   RETURN VALUE
    00228     status of attempt to connect
    00229   NOTES
    00230     If the status is not successful, call kusdb_error_text to get more
    00231     information about the failure.
    00232     Refer to the documentation for the format of information in the
    00233     database_name and security_info parameters.
    00234 */
    00235
    00236 kusst kusdb_connect (/*_
    00237            kusdb_handle db_handle,
    00238            ub4 database_name_length,
    00239            char *database_name,
    00240            ub4 security_info_length,
    00241            char *security_info
    00242            _*/);
    00243
    00244
    00245
    00246
    00247 /* ---------------------------- kusdb_disconnect --------------------------- */
    00248 /*
    00249   NAME
    00250     kusdb_disconnect - disconnect from a database
    00251   DESCRIPTION
    00252     Disconnect from the current database
    00253   PARAMETERS
    00254     db_handle - handle for the database (in/out)
    00255   RETURN VALUE
    00256     status of call
    00257   NOTES
    00258 */
    00259
    00260 kusst kusdb_disconnect (/*_ kusdb_handle db_handle _*/);
    00261
    00262
    00263
    00264
    00265 /* ------------------------------- kusdb_free ------------------------------ */
    00266 /*
    00267   NAME
    00268     kusdb_free - free a database handle
    00269   DESCRIPTION
    00270     free resources for a database handle
    00271   PARAMETERS
    00272     db_handle - handle for the database context (in/out)
    00273   RETURN VALUE
    00274     kusst - status of attempt to free the handle
    00275 */
    00276
    00277 kusst kusdb_free (/*_ kusdb_handle *db_handle _*/);
    00278
    00279
    00280
    00281
    00282 /* ----------------------------- kusdb_get_info ---------------------------- */
    00283 /*
    00284   NAME
    00285     kusdb_get_info - retrieve statistics for a database
    00286   DESCRIPTION
    00287     Retrieve requested statistics for the current database
    00288   PARAMETERS
    00289     db_handle - handle for the database (in)
    00290     context_handle - handle for the continuation context (in/out)
    00291     info_buf - TLV buffer indicating data to be returned (in)
    00292     info_buf_len - number of bytes in info_buffer (in)
    00293     result_buf - allocated TLV buffer to hold data returned (in/out)
    00294     result_buf_len - number of bytes in result_buf (in/out)
    00295     buffer_termination_status - indicates how buffer was terminated (normally,
    00296       truncated, or continued) (out)
    00297   RETURN VALUE
    00298     status of call
    00299   NOTES
    00300     If the status is not successful, call kusdb_error_text to get more
    00301     information about the failure.
    00302     Refer to documentation for information on the format of the information
    00303     buffer and the result buffer
    00304 */
    00305
    00306 kusst kusdb_get_info (/*_
    00307            kusdb_handle db_handle,
    00308            kuscx_handle ctx_handle,
    00309            ub1 *info_buffer,
    00310            ub4 info_buffer_length,
    00311            ub1 *result_buffer,
    00312            ub4 *result_buffer_length,
    00313            kustvs *buffer_termination_status
    00314            _*/);
    00315
    00316
    00317
    00318 /* ----------------------------- kusdb_get_memory -------------------------- */
    00319 /*
    00320   NAME
    00321     kusdb_get_memory - copy SGA contents into user-allocated memory
    00322   DESCRIPTION
    00323     Copy SGA memory into user-allocated memory regions. User provides
    00324     an array of kusmem structures. Each kusmem structure in the array
    00325     describes a distinct copy to be done by this routine.
    00326   PARAMETERS
    00327     db_handle - handle for the database (in)
    00328     mem_array_length - number of elements in mem_array (in)
    00329     mem_array - address of an array of kusmem structures (in/out)
    00330   RETURN VALUE
    00331     status of call:
    00332         KUSSTOK - call succeeded, all requested data copied
    00333         KUSSTIDH - invalid database handle
    00334         KUSSTDBDOWN - database is down
    00335         KUSSTERR - unexpected error
    00336   NOTES
    00337      User should prepare each kusmem structure in array by filling in
    00338      values for sga_address_kusmem, length_kusmem and dest_address_kusmem
    00339      prior to making this call.
    00340
    00341      User is reponsible for allocating and deallocating the memory used
    00342      by mem_array and each region that a dest_address_kusmem points to.
    00343 */
    00344
    00345 kusst kusdb_get_memory (/*_
    00346            kusdb_handle db_handle,
    00347         ub4 mem_array_length,
    00348         kusmem *mem_array
    00349            _*/);
    00350
    00351
    00352
    00353
    00354 /* ---------------------------- kusdb_error_text --------------------------- */
    00355 /*
    00356   NAME
    00357     kusdb_error_text - error text
    00358   DESCRIPTION
    00359     Display information about status of last kusdb call
    00360   PARAMETERS
    00361     db_ctx - context whose errors are to be returned (in)
    00362     text_buf - buffer to hold error message (in/out)
    00363     text_buf_len - number of bytes in text buffer (in)
    00364     text_len_out - number of bytes written into text_buf
    00365   RETURN VALUE
    00366     status of call
    00367   NOTES
    00368 */
    00369
    00370 kusst kusdb_error_text (/*_ kusdb_handle db_ctx, char *text_buf,
    00371                                    ub4 text_buf_len, ub4 *text_len_out _*/);
    00372
    00373
    00374
    00375
    00376 /* ------------------------ kustv_allocate_handle -------------------------- */
    00377 /*
    00378   NAME
    00379     kustv_allocate_handle - allocate a handle for a TLV buffer
    00380   DESCRIPTION
    00381     allocates and initializes information for a TLV handle
    00382   PARAMETERS
    00383     tlv_handle - handle of the TLV buffer (in/out)
    00384     tlv_buffer - address of the TLV buffer for this handle (in)
    00385     buf_size - number of bytes in tlv_buffer (in)
    00386   RETURN VALUE
    00387     KUSSTALL          Unable to allocate memory
    00388   NOTES
    00389     kustv_reinit can be used to reinitialize a TLV handle that is no longer
    00390     needed.
    00391 */
    00392
    00393 kusst kustv_allocate_handle (/*_
    00394            kustv_handle *tlv_handle,
    00395            ub1 *tlv_buffer,
    00396            ub4 buf_size
    00397            _*/);
    00398
    00399
    00400 #ifndef _WINDOWS
    00401
    00402
    00403 /* ------------------------------- kustv_dump -------------------------------*/
    00404 /*
    00405   NAME
    00406     kustv_dump - dump tlv buffer
    00407   DESCRIPTION
    00408     Formats the content of a TLV buffer into the file specified by the caller
    00409   PARAMETERS
    00410     tlv_handle - handle of the TLV buffer to be dumped (in)
    00411     header - ASCIZ string to be displayed before dumping the buffer (in)
    00412     data_flg - flag to indicate if the contents of the value fueld in the TLV
    00413            should be displayed (in)
    00414     append_flg - flag to indicate if an existing instance of the output
    00415         file should be appended to (or replaced)
    00416     get_tagname - routine to get text associated with tags
    00417     directory - ASCIZ string containing a directory specification for the
    00418         output file (if absent, current default directory is used)
    00419     file_name - ASCIZ string containing a file name for the output file.
    00420         If absent, stderr is used and append_flg and directory are ignored.
    00421         If specified without an extension, the Oracle extension for an output
    00422         file on the given platform is used.
    00423   RETURN VALUE
    00424     KUSSTOK           Success
    00425     KUSSTITH          invalid tlv handle
    00426     KUSSTDMPOP  can't open dump file
    00427     KUSSTDMPCL  can't close dump file
    00428   NOTES
    00429 */
    00430
    00431 kusst kustv_dump (/*_
    00432            kustv_handle tlv_handle,
    00433            CONST char *header,
    00434            int data_flg,
    00435         int append_flg,
    00436         CONST char *(*get_tagname)(ub2),
    00437         CONST char *directory,
    00438         CONST char *file_name
    00439            _*/);
    00440
    00441 #endif
    00442
    00443
    00444 /* ------------------------- kustv_free_handle ----------------------------- */
    00445 /*
    00446   NAME
    00447     kustv_free_handle - free a handle for a TLV buffer
    00448   DESCRIPTION
    00449     Free a TLV handle that has already been created
    00450   PARAMETERS
    00451     tlv_handle - handle of the TLV buffer (in/out)
    00452   RETURN VALUE
    00453     status of call
    00454   NOTES
    00455     kustv_reinit_handle can be used to reinitialize a handle that is no
    00456     longer needed.
    00457 */
    00458
    00459 kusst kustv_free_handle (/*_ kustv_handle *tlv_handle _*/);
    00460
    00461 /* ----------------------------- kussys_get_info --------------------------- */
    00462 /*
    00463   NAME
    00464     kussys_get_info - retrieve non database specific data
    00465   DESCRIPTION
    00466     Retrieve non database specific information
    00467   PARAMETERS
    00468     context_handle - handle for the continuation context (in/out)
    00469     info_buf - TLV buffer indicating data to be returned (in)
    00470     info_buf_len - number of bytes in info_buffer (in)
    00471     result_buf - allocated TLV buffer to hold data returned (in/out)
    00472     result_buf_len - number of bytes in result_buf (in/out)
    00473     buffer_termination_status - indicates how buffer was terminated (normally,
    00474       truncated, or continued) (out)
    00475   RETURN VALUE
    00476     status of call
    00477   NOTES
    00478     This function is a noop for Oracle. It is included for compatability
    00479     with Rdb only.
    00480 */
    00481
    00482 kusst kussys_get_info (/*_
    00483            kuscx_handle ctx_handle,
    00484            ub1 *info_buffer,
    00485            ub4 info_buffer_length,
    00486            ub1 *result_buffer,
    00487            ub4 *result_buffer_length,
    00488            kustvs *buffer_termination_status
    00489            _*/);
    00490
    00491
    00492
    00493
    00494
    00495 /* ---------------------------- kussys_error_text -------------------------- */
    00496 /*
    00497   NAME
    00498     kussys_error_text - error text
    00499   DESCRIPTION
    00500     Display information about status of last kustv call
    00501   PARAMETERS
    00502     text_buf - buffer to hold error message (in/out)
    00503     text_buf_len - number of bytes in text buffer (in)
    00504     text_len_out - number of bytes written into text_buf
    00505   RETURN VALUE
    00506     status of call
    00507   NOTES
    00508     This function is a noop for Oracle. It is included for compatability
    00509     with Rdb only.
    00510 */
    00511
    00512 kusst kussys_error_text (/*_ char *text_buf,
    00513                                    ub4 text_buf_len, ub4 *text_len_out _*/);
    00514
    00515
    00516
    00517
    00518 /* ------------------------------ kustv_get -------------------------------- */
    00519 /*
    00520   NAME
    00521     kustv_get - get next entry in tlv buffer
    00522   DESCRIPTION
    00523     Retrieves information about next entry in the tlv buffer and advances
    00524     pointer into the TLV buffer to the following entry.
    00525   PARAMETERS
    00526     tlv_handle - handle of the TLV buffer (in)
    00527     tag - tag for the next entry (out)
    00528     length - number of bytes in the value for the TLV entry (out)
    00529     value - pointer to value field for the TLV entry (out)
    00530   RETURN VALUE
    00531     KUSSTOK           Success
    00532     KUSSTITH          Invalid TLV handle
    00533   NOTES
    00534 */
    00535
    00536 kusst kustv_get (/*_
    00537            kustv_handle tlv_handle,
    00538            ub2 *tag,
    00539            ub2 *length,
    00540            ub1 **value
    00541            _*/);
    00542
    00543
    00544
    00545
    00546
    00547 /* ------------------------ kustv_reinit_handle ---------------------------- */
    00548 /*
    00549   NAME
    00550     kustv_reinit_handle - reinitialize a TLV handle
    00551   DESCRIPTION
    00552     Reimitializes a TLV handle so that it can be used to read or write a new
    00553     TLV buffer.
    00554   PARAMETERS
    00555     tlv_handle - handle of the TLV buffer (in/out)
    00556     buffer - address of the TLV buffer
    00557     buffer_size - number of bytes in the TLV buffer
    00558   RETURN VALUE
    00559     KUSSTOK           Success
    00560     KUSSTITH          Invalid TLV handle
    00561   NOTES
    00562 */
    00563
    00564 kusst kustv_reinit_handle (/*_
    00565            kustv_handle tlv_handle,
    00566            ub1 *buffer,
    00567            ub4 buffer_length
    00568            _*/);
    00569
    00570
    00571
    00572
    00573
    00574 /* --------------------------- kustv_length -------------------------------- */
    00575
    00576 /*
    00577   NAME
    00578     kustv_length - return length of a TLV buffer
    00579   DESCRIPTION
    00580     return the length of a TLV buffer associated with a TLV handle
    00581   PARAMETERS
    00582     tlv_handle - handle of the TLV buffer (in)
    00583     buffer_length - number of bytes in the buffer (out)
    00584   RETURN VALUE
    00585     KUSSTOK           Success
    00586     KUSSTITL          Invalid TLV handle
    00587   NOTES
    00588 */
    00589
    00590 kusst kustv_length (/*_
    00591            kustv_handle tlv_handle,
    00592            ub4 buffer_length
    00593            _*/);
    00594
    00595
    00596
    00597
    00598 /* ---------------------------- kustv_offset ------------------------------- */
    00599
    00600 /*
    00601   NAME
    00602     kustv_offset - return offset of a TLV buffer
    00603   DESCRIPTION
    00604     return the current offset of a TLV buffer associated with a TLV handle
    00605   PARAMETERS
    00606     tlv_handle - handle of the TLV buffer (in)
    00607     offset - current offset for TLV buffer (out)
    00608   RETURN VALUE
    00609     KUSSTOK - success
    00610     KUSSTITH - invalid TLV handle
    00611   NOTES
    00612 */
    00613
    00614 kusst kustv_offset (/*_
    00615            kustv_handle tlv_handle,
    00616            ub4 *offset
    00617            _*/);
    00618
    00619
    00620
    00621
    00622 /* ------------------------ kustvp1_put_one_byte --------------------------- */
    00623
    00624 /*
    00625   NAME
    00626     kustvp1_put_one_byte - Insert a TLV entry with a value field of 1 byte
    00627   DESCRIPTION
    00628     Adds a new TLV entry to the end of the current TLV buffer.  This entry
    00629     contains 1 byte.
    00630   PARAMETERS
    00631     tlv_handle - handle of the TLV buffer (in/out)
    00632     tag - tag for the new entry (in)
    00633     value - value for the new entry (in)
    00634   RETURN VALUE
    00635     status of the operation
    00636   NOTES
    00637 */
    00638
    00639 kusst kustvp1_put_one_byte (/*_
    00640            kustv_handle tlv_handle,
    00641            ub2 tag,
    00642            ub1 value
    00643            _*/);
    00644
    00645
    00646
    00647
    00648 /* ------------------------- kustvp2_put_two_bytes ------------------------- */
    00649
    00650 /*
    00651   NAME
    00652     kustvp2_put_two_bytes - Insert a TLV entry with a value field of 2 byte
    00653   DESCRIPTION
    00654     Adds a new TLV entry to the end of the current TLV buffer.  This entry
    00655     contains 2 bytes.
    00656   PARAMETERS
    00657     tlv_handle - handle of the TLV buffer (in/out)
    00658     tag - tag for the new entry (in)
    00659     value - value for the new entry (in)
    00660   RETURN VALUE
    00661     status of the operation
    00662   NOTES
    00663 */
    00664
    00665 kusst kustvp2_put_two_bytes (/*_
    00666            kustv_handle tlv_handle,
    00667            ub2 tag,
    00668            ub2 value
    00669            _*/);
    00670
    00671
    00672
    00673
    00674 /* ----------------------- kustvp4_put_four_bytes -------------------------- */
    00675
    00676 /*
    00677   NAME
    00678     kustvp4_put_four_bytes - Insert a TLV entry with a value field of 4 byte
    00679   DESCRIPTION
    00680     Adds a new TLV entry to the end of the current TLV buffer.  This entry
    00681     contains 4 bytes.
    00682   PARAMETERS
    00683     tlv_handle - handle of the TLV buffer (in/out)
    00684     tag - tag for the new entry (in)
    00685     value - value for the new entry (in)
    00686   RETURN VALUE
    00687     status of the operation
    00688   NOTES
    00689 */
    00690
    00691 kusst kustvp4_put_four_bytes (/*_
    00692            kustv_handle tlv_handle,
    00693            ub2 tag,
    00694            ub4 value
    00695            _*/);
    00696
    00697
    00698
    00699
    00700 /* ----------------------------- kustv_put --------------------------------- */
    00701
    00702 /*
    00703   NAME
    00704     kustv_put - Insert a TLV entry
    00705   DESCRIPTION
    00706     Adds a new TLV entry to the end of the current TLV buffer.
    00707   PARAMETERS
    00708     tlv_handle - handle of the TLV buffer (in/out)
    00709     tag - tag for the new entry (in)
    00710     length - number of bytes in the new entry (in)
    00711     value - value for the new entry (in)
    00712   RETURN VALUE
    00713     status of the operation
    00714   NOTES
    00715 */
    00716
    00717 kusst kustv_put (/*_
    00718            kustv_handle tlv_handle,
    00719            ub2 tag,
    00720            ub2 length,
    00721            dvoid *value
    00722            _*/);
    00723
    00724
    00725
    00726
    00727 /* -------------------------- kustvptg_put_tag ----------------------------- */
    00728
    00729 /*
    00730   NAME
    00731     kustvptg_put_tag - Insert a TLV entry with no value field
    00732   DESCRIPTION
    00733     Adds a new TLV entry to the end of the current TLV buffer.  the entry
    00734     contains a 0-length value field.
    00735   PARAMETERS
    00736     tlv_handle - handle of the TLV buffer (in/out)
    00737     tag - tag for the new entry (in)
    00738   RETURN VALUE
    00739     status of the operation
    00740   NOTES
    00741 */
    00742
    00743 kusst kustvptg_put_tag (/*_
    00744            kustv_handle tlv_handle,
    00745            ub2 tag
    00746            _*/);
    00747
    00748
    00749
    00750
    00751
    00752 /* -------------------------- kustv_buffer_state --------------------------- */
    00753
    00754 /*
    00755   NAME
    00756     kustv_buffer_state - return termination state of TLV buffer
    00757   DESCRIPTION
    00758     Returns informationon how a TLV buffer was terminated.  This call returns
    00759     useful information only if a TLV handle was used to read or write the
    00760     termination tag.  The termination information is preserved
    00761   PARAMETERS
    00762     tlv_handle - handle of the TLV buffer (in)
    00763     state - termination state for the TLV (out)
    00764   RETURN VALUE
    00765     status of the operation
    00766   NOTES
    00767 */
    00768
    00769 kusst kustv_buffer_state (/*_
    00770            kustv_handle tlv_handle,
    00771            kustvs *state
    00772            _*/);
    00773
    00774
    00775 #endif                                              /* kusapi */

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines