Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

kate_packet


Functions

int kate_packet_wrap (kate_packet *kp, size_t nbytes, const void *data)
int kate_packet_init (kate_packet *kp, size_t nbytes, const void *data)
int kate_packet_clear (kate_packet *kp)


Function Documentation

int kate_packet_clear kate_packet kp  ) 
 

Clears a kate_packet previously initialized by kate_packet_init

Parameters:
kp the kate_packet to clear
Returns:
0 success

KATE_E_* error

int kate_packet_init kate_packet kp,
size_t  nbytes,
const void *  data
 

Returns a kate_packet created from the given data. The data is copied, so can be freed once the kate_packet is created. The kate_packet should be cleared when not needed anymore.

Parameters:
kp the kate_packet to create
nbytes the number of bytes in the data to wrap
data a pointer to the data to wrap
Returns:
0 success

KATE_E_* error

int kate_packet_wrap kate_packet kp,
size_t  nbytes,
const void *  data
 

Returns a kate_packet wrapping the given data. The data is not copied, so should stay valid throughout the use of the kate_packet. The kate_packet should not be cleared.

Parameters:
kp the kate_packet to wrap
nbytes the number of bytes in the data to wrap
data a pointer to the data to wrap
Returns:
0 success

KATE_E_* error


Generated on Wed Nov 17 09:57:31 2010 for libkate by  doxygen 1.3.9.1