index

SybIODesc

SybIODesc implements CS_IODESC structure (data I/O descriptor) of SyBase Client Library.
Normally, this object is retrieved by SybCommand#get_iodesc method.

Methods

props ( hash=nil )

If hash was specified in param, This method updates fields of CS_IODESC structure, and returns a Hash object after update

If hash was omitted, This method returns the current fields of CS_IODESC structure as Hash object.

hash parameter's key is equivalent to the fieldname of CS_IODESC structure.
hash parameter's value is equivalent to the field value of CS_IODESC structure.

Details for key-value pair for hash parameter

Key	Value
'datatype'	SybConstant::CS_IMAGE_TYPE or CS_TEXT_TYPE
'total_txtlen'	Total data length ,in bytes
'log_on_update'	true -- The server updates transaction log false -- The server does not update transaction log
'name'	column name
'timestamp'	timestamp(String object)
'textptr'	The text pointer fot the column(String object)

Examples
( Does not update transaction log, and Sets total lenghth to 1234 byte.)

  iodesc.props( { 'log_on_update'=> false ,
                  'total_txtlen' => 1234 } )