Main Page | Data Structures | File List | Data Fields | Globals

lasso_value_t Struct Reference

Used for retrieving data from some LCAPI functions. More...

#include <LassoCAPI.h>


Data Fields

const char * name
 The name portion.
unsigned int nameSize
 The size of the name member, in bytes.
const char * data
 The value portion.
unsigned int dataSize
 The size of the data member, in bytes.
LP_TypeDesc type
 The type code for the data member.


Detailed Description

Used for retrieving data from some LCAPI functions.

The lasso_value_t struct is used for shuffling data into and out of LassoCAPI functions.

Any LCAPI function that constructs one of these will insure that Lasso properly disposes of the data once the user's LassoCAPI function call is complete.

lasso_value_t is suitable for transferring binary data as long as the nameSize or dataSize members are properly set with the size of the data in bytes.

Depending on the purpose of the function which is constructing the lasso_value_t, any combination of the name or data members may be filled in or may be NULL. Consult the documentation of the specific function for more details.

Should be initialized using the INITVAL(X) macro before use.


Field Documentation

const char* lasso_value_t::data
 

The value portion.

May be NULL.

unsigned int lasso_value_t::dataSize
 

The size of the data member, in bytes.

const char* lasso_value_t::name
 

The name portion.

May be NULL.

unsigned int lasso_value_t::nameSize
 

The size of the name member, in bytes.

LP_TypeDesc lasso_value_t::type
 

The type code for the data member.


The documentation for this struct was generated from the following file:
Generated on Mon Nov 15 10:33:10 2004 for LassoCAPI by doxygen 1.3.8