SqlVarLengthAttachedType Class Reference

Encapsulates variable sized, buffer based SQL Types where the buffer is supplied. More...

Inherits Simba::Support::SqlData.

List of all members.

Public Member Functions

virtual void AttachBuffer (simba_byte *in_buffer, simba_uint32 in_length)
 Attach an unowned buffer, replacing the owned buffer.
void * GetBuffer ()
 Returns the attached buffer.
void InlineAttachBuffer (simba_byte *in_buffer, simba_uint32 in_length)
 Attach an unowned buffer, replacing the owned buffer.
void SetLength (simba_uint32 in_length)
 Sets the length of the buffer in number of bytes.
 SqlVarLengthAttachedType (SqlTypeMetadata *in_metadata)
 Constructor.
virtual ~SqlVarLengthAttachedType ()
 Destructor.

Protected Attributes

simba_bytem_dataBuffer

Detailed Description

Encapsulates variable sized, buffer based SQL Types where the buffer is supplied.


Constructor & Destructor Documentation

SqlVarLengthAttachedType ( SqlTypeMetadata in_metadata  ) 

Constructor.

Parameters:
in_metadata The metadata for the SQL object. (NOT OWN)
virtual ~SqlVarLengthAttachedType (  )  [virtual]

Destructor.


Member Function Documentation

virtual void AttachBuffer ( simba_byte in_buffer,
simba_uint32  in_length 
) [virtual]

Attach an unowned buffer, replacing the owned buffer.

This also sets the length. This method has no effect on fixed length types.

Any buffers allocated via SetLength will be released, and calling SetLength() with a buffer already attached will detach the buffer and allocate a new owned buffer. Data will not be copied from attached to owned buffers.

Parameters:
in_buffer Buffer to attach. May be NULL only for in_length 0. (NOT OWN)
in_length Length of in_buffer.

Reimplemented from SqlData.

void* GetBuffer (  )  [virtual]

Returns the attached buffer.

Returns:
The data buffer. (NOT OWN)

Implements SqlData.

void InlineAttachBuffer ( simba_byte in_buffer,
simba_uint32  in_length 
) [inline]

Attach an unowned buffer, replacing the owned buffer.

This also sets the length. This method has no effect on fixed length types.

Any buffers allocated via SetLength will be released, and calling SetLength() with a buffer already attached will detach the buffer and allocate a new owned buffer. Data will not be copied from attached to owned buffers.

Parameters:
in_buffer Buffer to attach. May be NULL only for in_length 0. (NOT OWN)
in_length Length of in_buffer.
void SetLength ( simba_uint32  in_length  )  [virtual]

Sets the length of the buffer in number of bytes.

This method has no effect for fixed length types.

Parameters:
in_length 

Reimplemented from SqlData.


Member Data Documentation

simba_byte* m_dataBuffer [protected]

The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:19 2017 for SimbaEngine 10.1.3.1011 by simba