MyCQ.QueueSchema Interface Reference

Makes or represents columns of a QueueSchema. More...

List of all members.

Public Member Functions

void addBoolean (string columnName)
 Add a new BOOLEAN type column. See: ColumnType
void addByte (string columnName)
 Add a new BYTE type column. See: ColumnType
void addShort (string columnName)
 Add a new SHORT type column. See: ColumnType
void addUShort (string columnName)
 Add a new USHORT type column. See: ColumnType
void addInt (string columnName)
 Add a new INT type column. See: ColumnType
void addLong (string columnName)
 Add a new LONG type column. See: ColumnType
void addFloat (string columnName)
 Add a new FLOAT type column. See: ColumnType
void addDouble (string columnName)
 Add a new DOUBLE type column. See: ColumnType
void addDate (string columnName)
 Add a new DATE type column. See: ColumnType
void addTime (string columnName)
 Add a new TIME type column. See: ColumnType
void addDateTime (string columnName)
 Add a new DATETIME type column. See: ColumnType
void addString (string columnName, int size)
 Add a new STRING type column. See: ColumnType
void addVarString (string columnName)
 Add a new VAR_STRING type column. See: ColumnType
void addBinary (string columnName, int size)
 Add a new BINARY type column. See: ColumnType
void addVarBinary (string columnName)
 Add a new VAR_BINARY type column. See: ColumnType
List< ColumngetColumns ()
 Get the column list a queue schema.
void clear ()
 Clear all the columns in a queue schema.
int getMessageSize ()
 Get the message size. It is a total size of columns of a queue schema.

Detailed Description

Makes or represents columns of a QueueSchema.


Member Function Documentation

void MyCQ.QueueSchema.addBinary ( string  columnName,
int  size 
)

Add a new BINARY type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
size An integer greater than zero that will be the size of BINARY type column.
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addBoolean ( string  columnName  ) 

Add a new BOOLEAN type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addByte ( string  columnName  ) 

Add a new BYTE type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addDate ( string  columnName  ) 

Add a new DATE type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addDateTime ( string  columnName  ) 

Add a new DATETIME type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addDouble ( string  columnName  ) 

Add a new DOUBLE type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addFloat ( string  columnName  ) 

Add a new FLOAT type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addInt ( string  columnName  ) 

Add a new INT type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addLong ( string  columnName  ) 

Add a new LONG type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addShort ( string  columnName  ) 

Add a new SHORT type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addString ( string  columnName,
int  size 
)

Add a new STRING type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
size An integer greater than zero that will be the size of STRING type column.
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addTime ( string  columnName  ) 

Add a new TIME type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addUShort ( string  columnName  ) 

Add a new USHORT type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addVarBinary ( string  columnName  ) 

Add a new VAR_BINARY type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.addVarString ( string  columnName  ) 

Add a new VAR_STRING type column. See: ColumnType

Parameters:
columnName A column name that will be created in a queue schema. A column name is a combination of alphabets and numerics which starts with alphabet character. (size:= under 64).
Exceptions:
MyCQException An error occurred. check error code.
void MyCQ.QueueSchema.clear (  ) 

Clear all the columns in a queue schema.

List<Column> MyCQ.QueueSchema.getColumns (  ) 

Get the column list a queue schema.

Returns:
Column list.
int MyCQ.QueueSchema.getMessageSize (  ) 

Get the message size. It is a total size of columns of a queue schema.

Returns:
An integer of a message size. It returns zero if there is no column or variable column(s) in a queue schema.

The documentation for this interface was generated from the following file:
 All Classes Functions Variables Properties
MyCQ .NET User's Document. Copyright@MyCQ Inc., All Rights Reserved.