CAA Segemented Buffer Manager ¶ Enums ERROR (Enum) Functions Buffer ChainBuffer (Function) CopyBufferData (Function) CreateBuffer (Function) DeleteBuffer (Function) GetBufferSize (Function)
ERROR (ENUM) ¶ TYPE ERROR : This data structure describes errors, which might occur during handling functions of CAA_SegBufferMan.lib. Attributes: qualified_only InOut: Name Initial Comment NO_ERROR 0 No error FIRST_ERROR 6100 First library-specific error TIME_OUT 6101 = Time limit exceeded FIRST_MF 6102 = First manufacturer-specific error LAST_ERROR 6199 Latest library-specific error
Functions ¶ Buffer ChainBuffer (Function) CopyBufferData (Function) CreateBuffer (Function) DeleteBuffer (Function) GetBufferSize (Function)
Buffer ¶ ChainBuffer (Function) CopyBufferData (Function) CreateBuffer (Function) DeleteBuffer (Function) GetBufferSize (Function)
ChainBuffer (FUN) ¶ FUNCTION ChainBuffer : CAA.HANDLE Split the buffer into a chain of segments InOut: Scope Name Type Comment Return ChainBuffer CAA.HANDLE Handle to the buffer Input hHead CAA.HANDLE Head hBuffer hTail CAA.HANDLE Tail hBuffer peError POINTER TO ERROR Local library ERROR ID
CopyBufferData (FUN) ¶ FUNCTION CopyBufferData : ERROR Copy data from the segmented buffer to a destination buffer InOut: Scope Name Type Comment Return CopyBufferData ERROR Local library ERROR ID Input hBuffer CAA.HANDLE Handle to the buffer created by CreateBuffer szOffset CAA.SIZE Offset in Buffer szLength CAA.SIZE Length of Data to Copy pData CAA.PVOID Destination szSize CAA.SIZE Size of Destination
CreateBuffer (FUN) ¶ FUNCTION CreateBuffer : CAA.HANDLE Create a segmented buffer InOut: Scope Name Type Comment Return CreateBuffer CAA.HANDLE Handle to the buffer Input szSize CAA.SIZE size of the new Buffer pData CAA.PVOID Pointer to initial data. CAA.gc_pNULL => Init with zero xPermanent BOOL TRUE => Buffer is immutable peError POINTER TO ERROR Local library ERROR ID
DeleteBuffer (FUN) ¶ FUNCTION DeleteBuffer : ERROR Delete a segmented buffer InOut: Scope Name Type Comment Return DeleteBuffer ERROR Local library ERROR ID Input hBuffer CAA.HANDLE Handle to the buffer created by CreateBuffer
GetBufferSize (FUN) ¶ FUNCTION GetBufferSize : CAA.SIZE Get the size of the segmented buffer in bytes InOut: Scope Name Type Comment Return GetBufferSize CAA.SIZE Get the buffer size in bytes Input hBuffer CAA.HANDLE Handle to the buffer created by CreateBuffer peError POINTER TO ERROR Local library ERROR ID
