ObjectDatabase++ Documentation

Delevopers ObjectDatabase++ API Get Variable Field

GetVariableField

GetVariableField return the address of the begining of the variable field requested.

unsigned int GetVariableField (
	unsigned int tableID,
	unsigned int variableField,
	void** returnPosition,
	CODBPP::Object *object = NULL
);
unsigned int GetVariableField (
	unsigned int tableID,
	unsigned int variableField,
	unsigned int subField,
	unsigned int row,
	void** returnPosition,
	CODBPP::Object *object = NULL
);

Parameters

tableID	The table ID defining the table's handle.
variableField	The position of the variable field, the first variable field is 0
subField	The position of the sub-field within the CODBPP::SUB_TABLE, the first field is 0 whether fixed or variable.
row	The row for the sub-field required, 0 for the first.
returnPosition	Pointer for the returned position
object	Enables the user to re-grab the object handles

Return Values

If the method succeeds, the return value is zero else see error codes for more details. If the method is unable to find the position it sets returnPosition to NULL.

Remarks

Example Use

#define TABLE_ONE 1
struct VariableObject{
   int First;
   double Second;
   enum {FirstVar, SecondVar};
};
char16_t *message;
if(database.BeginTransaction() == NO_ERROR
&& database.OpenTable(TABLE_ONE) == NO_ERROR
&& database.ReadObject(TABLE_ONE,CODBPP::FIRST) == NO_ERROR
&& database.GetVariableField(TABLE_ONE,VariableObject::SecondVar,&message) == NO_ERROR)
   MessagaBox(message);
else if(database.GetErrorMessage(&message) == NO_ERROR) MessageBox(message);
database.EndTransaction();

Also See

ReadObject, PutVariableValues