Mimer SQL Documentation TOC PREV NEXT INDEX

Mimer SQL Developer Site


Real-Time API Specification


The following routines are included in the Mimer SQL Real-Time API:

Routine
Description
Mimer SQL Auto compatible
 MimerRTAttachTask
Attaches a real-time task to a real-time database.
Yes
 MimerRTBeginDatabase
Creates a handle for a real-time database.
Yes
 MimerRTBeginDatabaseC
Creates a handle for a real-time database, using char interface.
Yes
 MimerRTBeginSession
Creates a real-time session to a real-time database.
Yes
 MimerRTBeginSessionC
Creates a real-time session to a real-time database, using char interface.
Yes
 MimerRTBindDbp
Submits an SQL-query to the database server, which creates a new database pointer and binds it to the data element pointed out by the query.
Yes
 MimerRTBindDbpC
Submits an SQL-query to the database server, which creates a new database pointer and binds it to the data element pointed out by the query. Uses the char interface.
Yes
 MimerRTDbpInfo
Retrieves information about a database pointer.
Yes
 MimerRTDetachTask
Detaches a real-time task from a real-time database.
Yes
 MimerRTEndDatabase
Ends a real-time database handle.
Yes
 MimerRTEndSession
Ends a real-time session.
Yes
 MimerRTFlushAll
Flushes all database pointers to persistent storage.

 MimerRTFlushDbp
Flushes a multirow database pointer to persistent storage.

 MimerRTGetDouble
Reads a 64-bit floating point from a database pointer.
Yes
 MimerRTGetFloat
Reads a 32-bit floating point from a database pointer.
Yes
 MimerRTGetInt16
Reads a 16-bit integer from a database pointer.
Yes
 MimerRTGetInt32
Reads a 32-bit integer from a database pointer.
Yes
 MimerRTGetInt64
Reads a 64-bit integer from a database pointer.
Yes
 MimerRTGetMultiColumn
Reads a multicolumn database pointer from the database.
Yes
 MimerRTGetStringL
Reads a null-terminated Latin-1 character string from a database pointer.
Yes
 MimerRTGetTimestampC
Reads a TIMESTAMP from a database pointer.
Yes
 MimerRTMoveReader
Changes record to read from for multirow log-reader.
Yes
 MimerRTMoveWriter
Changes record to write to for multirow log-reader.
Yes
 MimerRTSelectColumn
Selects the active column for multicolumn database pointers.
Yes
 MimerRTSetDouble
Writes a 64-bit floating point to a database pointer.
Yes
 MimerRTSetFloat
Writes a 32-bit floating point to a database pointer.
Yes
 MimerRTSetInt16
Writes a 16-bit integer to a database pointer.
Yes
 MimerRTSetInt32
Writes a 32-bit integer to a database pointer.
Yes
 MimerRTSetInt64
Writes a 64-bit integer to a database pointer.
Yes
 MimerRTSetMultiColumn
Writes a multicolumn database pointer to the database.
Yes
 MimerRTSetStringL
Writes a null-terminated Latin-1 character string to a database pointer.
Yes
 MimerRTSetTimestampC
Writes a TIMESTAMP to a database pointer.
Yes
 MimerRTUnbindDbp
Removes a database pointer.
Yes

MimerRTAttachTask

Attaches a task for use with a real-time database.

Description

The MimerRTAttachTask routine attaches a task (thread) into a real-time database. The attaching ensures synchronization of real-time data access towards the real-time database. The routine must be called once for each task that uses real-time database operations for a real-time database.

Parameters

int32_t MimerRTAttachTask (

            MimerRTDatabase *hrtdb)

hrtdb
in
The real-time database to attach.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

Mimer SQL Auto compatible.

MimerRTBeginDatabase

Initializes a real-time database.

Description

MimerRTBeginDatabase sets up a database for real-time use. The database server name and the number of application tasks that will access the database are given. Multiple real-time sessions towards the database server can be created for a database. The MimerRTBeginDatabase routine should be called once, prior to any other calls to the database.

Parameters

 int32_t MimerRTBeginDatabase (
             const wchar_t *database,
             int32_t nofTasks,
             MimerRTDatabase *hrtdb)

database
in
The database name. If set to L"", the database declared in the MIMER_DATABASE environment variable will be used.
nofTasks
in
The maximum number of tasks that can attach to the database.
hrtdb
out
The real-time database handle.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Notes

This routine interacts with the database server.

This routine is not re-entrant.

Mimer SQL Auto compatible.

MimerRTBeginDatabaseC

Initializes a real-time database, using char interface.

Description

MimerRTBeginDatabaseC sets up a database for real-time use. The database server name and the number of application tasks that will access the database are given. Multiple real-time sessions towards the database server can be created for a database. The MimerRTBeginDatabaseC routine should be called once, prior to any other calls to the database.

Parameters

int32_t MimerRTBeginDatabaseC (

            const char *database,

            int32_t nofTasks,

             MimerRTDatabase *hrtdb)

database
in
The database name. If set to "", the database declared in the MIMER_DATABASE environment variable will be used.
nofTasks
in
The maximum number of tasks that can attach to the database.
hrtdb
out
The real-time database handle.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine interacts with the database server.

This routine is not re-entrant.

Mimer SQL Auto compatible.

MimerRTBeginSession

Begins a real-time database session.

Description

The MimerRTBeginSession routine creates a session to a real-time database. Multiple real-time database sessions can be made for one real-time database.

Parameters

int32_t MimerRTBeginSession (

            MimerRTDatabase hrtdb,

            const wchar_t *userName,

            const wchar_t *passWord,

            MimerRTSession *hrtsess)

hrtdb
in
The real-time database handle.
userName
in
The database ident.
passWord
in
The password for the ident.
hrtsess
out
The real-time session handle.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine interacts with the database server.

Mimer SQL Auto compatible.

MimerRTBeginSessionC

Begins a real-time database session , using char interface.

Description

The MimerRTBeginSessionC routine creates a session to a real-time database. Multiple real-time database sessions can be made for one real-time database.

Parameters

int32_t MimerRTBeginSessionC (

            MimerRTDatabase hrtdb,

            const char *userName,

            const char *passWord,

            MimerRTSession *hrtsess)

hrtdb
in
The real-time database handle.
userName
in
The database ident.
passWord
in
The password for the ident.
hrtsess
out
The real-time session handle.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine interacts with the database server.

Mimer SQL Auto compatible.

MimerRTBindDbp

Binds a database pointer to a specific data element in the database.

Description

MimerRTBindDbp submits an SQL-query to the database server, which creates a real-time entry to the data element pointed out by the query.

The sqlQuery parameter must adhere to the following:

Parameters

int32_t MimerRTBindDbp (

            MimerRTSession hrtsess,

            const wchar_t *sqlQuery,

            int32_t attributes,

            MimerRTDbp *dbp)

hrtsess
in
The session in which to bind the database pointer.
sqlQuery
in
An SQL query to locate the data element to bind to.
attributes
in
The attributes for this database pointer (see below).
dbp
out
The database pointer to bind.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Remarks

The attributes for a database pointer can be divided into two categories; (i) Database pointer type and (ii) Database pointer policy. The following types are supported:

The following policies (Multirow pointers only) are supported:

Multiple attributes can be combined using the or (|) operator. For example, the following attributes creates a singlecolumn, multirow logging pointer:

 DBP_SINGLECOLUMN|DBP_MULTIROW|DBP_LOGGINGPOLICY
 

For information on these policies, see Multirow Database Pointers.

Note

This routine interacts with the database server.

Mimer SQL Auto compatible.

MimerRTBindDbpC

Binds a database pointer to a specific data element in the database, using char interface.

Description

The MimerRTBindDbpC routine submits an SQL-query to the database server, which creates a real-time entry to the data element pointed out by the query.

The sqlQuery parameter must adhere to the following:

Parameters

int32_t MimerRTBindDbpC (

            MimerRTSession hrtsess,

            const char *sqlQuery,

            int32_t attributes,

            MimerRTDbp *dbp)

hrtsess
in
The session in which to bind the database pointer.
sqlQuery
in
An SQL query to locate the data element to bind to.
attributes
in
The attributes for this database pointer (see below).
dbp
out
The database pointer to bind.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Remarks

The attributes for a database pointer can be divided into two categories; (i) Database pointer type and (ii) Database pointer policy. The following types are supported:

The following policies (Multirow pointers only) are supported:

Multiple attributes can be combined using the or (|) operator. For example, the following attributes creates a singlecolumn, multirow logging pointer:

 DBP_SINGLECOLUMN|DBP_MULTIROW|DBP_LOGGINGPOLICY
 

For information on these policies, see Multirow Database Pointers.

Note

This routine interacts with the database server.

Mimer SQL Auto compatible.

MimerRTDbpInfo

Retrieves information on a database pointer.

Description

This function will allow the user to retrieve information on a database pointer.

Parameters

int32_t MimerRTDbpInfo (

            MimerRTDbp dbp,

            int32_t infoSel)

dbp
in
The database pointer.
infoSel
in
The indicator on what information that is selected. The infoSel can have any of the following values:
DBPINFO_GETDATATYPE - Gets the data type of the current column.
DBPINFO_GETLEN - Gets the length of the data type of the current column.

Returns

A negative value indicating an error, or the column data type if successful.

Return value
Description
-1
Non-existing column.
MIMERRT_CHARS
char[] is the datatype for the active column.
MIMERRT_SHORT
int16_t is the datatype for the active column.
MIMERRT_INTEGER
int32_t is the datatype for the active column.
MIMERRT_LONGLONG
int64_t is the datatype for the active column.
MIMERRT_TIMESTAMP
timestamp is the datatype for the active column.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTDetachTask

Detach a task for use with a real-time database.

Description

The MimerRTDetachTask routine detaches a task from a real-time database. The routine should be called after any other real-time database operation made by the task. Operations on database pointers by detached tasks will yield undefined behavior, with the possibility of database inconsistency/corruption.

Parameters

int32_t MimerRTDetachTask (

            MimerRTDatabase hrtdb)

hrtdb
in
The real-time database to detach.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

Mimer SQL Auto compatible.

MimerRTEndDatabase

Closes a real-time database.

Description

The MimerRTEndDatabase routine closes a database for real-time use.

The routine will return error if any sessions to the database are still active.

Parameters

int32_t MimerRTEndDatabase (

             MimerRTDatabase *hrtdb)

hrtdb
out
The real-time database handle.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

Mimer SQL Auto compatible.

MimerRTEndSession

Shut down a Real-time Session.

Description

The MimerRTEndSession routine should be called when all other Mimer RT API calls for the session have been finished. The routine returns all handles to the server, and shuts down the database connection.

Any database pointer that is still bound under the session will be unbound. Usage of any database pointer under a session that has been shut down might lead to unpredictable results.

Parameters

int32_t MimerRTEndSession (

             MimerRTSession *hrtsess)

hrtsess
inout
The real-time session handle.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine interacts with the database server.

Mimer SQL Auto compatible.

MimerRTFlushAll

Flushes all database pointers to persistent storage.

Description

This function will allow all database pointers in the server, including singlerow pointers and pointers created within other sessions and client applications, to be flushed to persistent storage.

The user performing the flush must have backup privileges for the database. See Mimer SQL Reference Manual, GRANT SYSTEM PRIVILEGE for details on privileges.

Parameters

int32_t MimerRTFlushAll (

            MimerRTSession hrtsess,

            int32_t policy)

hrtsess
in
The session to perform the flush under.
policy
in
(Currently not used.)

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
-1
Error.

Note

This routine interacts with the server and is not real-time.

Not Mimer SQL Auto compatible.

MimerRTFlushDbp

Flushes a multirow database pointer to persistent storage.

Description

This function will allow a multirow database pointer to be flushed to persistent storage.

The user performing the flush must have backup privileges for the database.

Parameters

int32_t MimerRTFlushDbp (

            MimerRTDbp dbp,

            int32_t policy)

dbp
in
The multirow database pointer.
policy
in
(Currently not used.)

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
-1
Error.

Note

This routine interacts with the server and is not real-time.

Not Mimer SQL Auto compatible.

MimerRTGetDouble

Reads a 64-bit floating point from a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly read from the database. In the case of a multicolumn database pointer, a call to MimerRTGetMultiColumn must precede this call in order for the value to be cached in the local storage for the database pointer.

After the read, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTGetDouble (

            MimerRTDbp dbp,

            double *doubleVal)

dbp
in
The database pointer to read from.
doubleVal
in
The floating point variable to write the result to.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTGetFloat

Reads a 32-bit floating point from a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly read from the database. In the case of a multicolumn database pointer, a call to MimerRTGetMultiColumn must precede this call in order for the value to be cached in the local storage for the database pointer.

After the read, the function will increment the current column to the next one in the set.

Parameters

int64_t MimerRTGetFloat (

            MimerRTDbp dbp,

            float *floatVal)

dbp
in
The database pointer to read from.
floatVal
out
The floating point variable to write the result to.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTGetInt16

Reads a 16-bit integer from a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly read from the database. In the case of a multicolumn database pointer, a call to MimerRTGetMultiColumn must precede this call in order for the value to be cached in the local storage for the database pointer.

After the read, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTGetInt16 (

            MimerRTDbp dbp,

            int16_t *shortVal)

dbp
in
The database pointer to read from.
shortVal
out
The integer variable to write the result to.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTGetInt32

Reads a 32-bit integer from a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly read from the database. In the case of a multicolumn database pointer, a call to MimerRTGetMultiColumn must precede this call in order for the value to be cached in the local storage for the database pointer.

After the read, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTGetInt32 (

            MimerRTDbp dbp,

            int32_t *intVal)

dbp
in
The database pointer to read from.
intVal
out
The integer variable to write the result to.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTGetInt64

Reads a 64-bit integer from a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly read from the database. In the case of a multicolumn database pointer, a call to MimerRTGetMultiColumn must precede this call in order for the value to be cached in the local storage for the database pointer.

After the read, the function will increment the current column to the next one in the set.

Parameters

int64_t MimerRTGetInt64 (

            MimerRTDbp dbp,

            int64_t *bigintVal)

dbp
in
The database pointer to read from.
bigintVal
out
The integer variable to write the result to.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTGetMultiColumn

Reads a multicolumn database pointer.

Description

This function will read all multicolumn data from the database and cache it in the local storage of the database pointer. The data can later be retrieved using the ordinary read and write operations, like for example MimerRTGetInt32.

Parameters

int32_t MimerRTGetMultiColumn (

            MimerRTDbp dbp)

dbp
in
The database pointer to read.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTGetStringL

Reads a null-terminated character string from a database pointer.

Description

The function reads the value of a database pointer which points to a CHAR(n). A null-termination is appended to the string. It is worth noting that a CHAR(n) is a fixed length string and that the null-termination will be placed in position n + 1 of the resulting string (charVal). For example if a CHAR(10) is used, charVal[0]-charVal[9] will contain the CHAR(10) and charVal[10] will contain the null-termination.

After the read, the function will increment the current column to the next one in the set.

In the case of a singlecolumn database pointer, the value will be directly read from the database. In the case of a multicolumn database pointer, a call to MimerRTGetMultiColumn must precede this call in order for the value to be cached in the local storage for the database pointer.

Parameters

int32_t MimerRTGetStringL (

            MimerRTDbp dbp,

            char *charVal)

dbp
in
The database pointer to read from.
charVal
out

The string to write the result to.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine explicitly uses the Latin-1 character representation (also called ISO 8859-1) without considering any locale settings.

This routine is real-time.

The routine assumes that the character string is at least one byte longer than the string pointed out by the database pointer.

Mimer SQL Auto compatible.

MimerRTGetTimestampC

Reads a timestamp from a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly read from the database. In the case of a multicolumn database pointer, a call to MimerRTGetMultiColumn must precede this call in order for the value to be cached in the local storage for the database pointer.

After the read, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTGetTimestampC (

            MimerRTDbp dbp,

            char *timestamp)

dbp
in
The database pointer to read from.
timestamp
out
The string variable to write the result to.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

The routine assumes that the string is at least one byte longer than the string pointed out by the database pointer.

Mimer SQL Auto compatible.

MimerRTMoveReader

Move the reader of a multirow logging pointer.

Description

This function will allow the user to select a specific row as active for reading (logging pointers), or for reading/writing (static pointers).

Parameters

int32_t MimerRTMoveReader (

            MimerRTDbp dbp,

            int32_t moveOp,

            int32_t offset)

dbp
in
The database pointer.
moveOp
in
The type of movement operation, can be any of the following:
MOVEROW_FORWARD - Moves the reader forward any number of rows (given by the offset parameter.)
MOVEROW_BACKWARD - Moves the reader backward any number of rows (given by the offset parameter.)
MOVEROW_LASTWRITTEN - Moves the reader to the last written row (offset parameter not used.)
MOVEROW_FIRST - Moves the reader to the first row in the set (offset parameter not used.)
offset
in
The number of rows to move from current position. (Used with options MOVEROW_FORWARD and MOVEROW_BACKWARD only.)

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
-1
Error.
MIMER_SUCCESS
Success.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTMoveWriter

Set row for the writer of a multirow logging pointer.

Description

This function will allow the user to move the writer to the currently active row (for the reader of a logging multirow pointer). The currently active row is the last read row. Users of this function should be aware that the function affects all writers of the multirow pointer. The typical use of this function is when resetting the multirow pointer after a system restart.

Parameters

int32_t MimerRTMoveWriter (

            MimerRTDbp dbp)

dbp
in
The database pointer.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
-1
If policy does not match.
-2
If reader is not initialized.
MIMER_SUCCESS
Success.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTSelectColumn

Selects column for a multicol database pointer.

Description

This function will allow the user to select a specific column as active for reading or writing.

Parameters

int32_t MimerRTSelectColumn (

            MimerRTDbp dbp,

            int16_t columnSel)

dbp
in
The database pointer.
columnSel
in
The column number (starting with 1) to set as active or relative selector (see below).

Returns

A negative value indicating an error, or the column data type if successful.

Return value
Description
-1
Non-existing column.
MIMERRT_CHARS
char[] is the datatype for the active column.
MIMERRT_SHORT
int16_t is the datatype for the active column.
MIMERRT_INTEGER
int32_t is the datatype for the active column.
MIMERRT_LONGLONG
int64_t is the datatype for the active column.
MIMERRT_TIMESTAMP
timestamp is the datatype for the active column.

Remarks

In addition to setting columnSel to the explicit column number, the following macros are available:

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTSetDouble

Writes a 64-bit floating point to a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly written to the database. In the case of a multicolumn database pointer, a call to MimerRTSetMultiColumn must be made after this call in order for the value to be moved from the database pointer local storage to the database.

After the write, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTSetDouble (

            MimerRTDbp dbp,

            double doubleVal)

dbp
in
The database pointer to write to.
doubleVal
in
The floating point value to write.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTSetFloat

Writes a 32-bit floating point to a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly written to the database. In the case of a multicolumn database pointer, a call to MimerRTSetMultiColumn must be made after this call in order for the value to be moved from the database pointer local storage to the database.

After the write, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTSetFloat (

            MimerRTDbp dbp,

            float floatVal)

dbp
in
The database pointer to write to.
floatVal
in
The floating point value to write.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTSetInt16

Writes a 16-bit integer to a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly written to the database. In the case of a multicolumn database pointer, a call to MimerRTSetMultiColumn must be made after this call in order for the value to be moved from the database pointer local storage to the database.

After the write, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTSetInt16 (

            MimerRTDbp dbp,

            int16_t shortVal)

dbp
in
The database pointer to write to.
shortVal
in
The integer value to write.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTSetInt32

Writes a 32-bit integer to a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly written to the database. In the case of a multicolumn database pointer, a call to MimerRTSetMultiColumn must be made after this call in order for the value to be moved from the database pointer local storage to the database.

After the write, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTSetInt32 (

            MimerRTDbp dbp,

            int32_t intVal)

dbp
in
The database pointer to write to.
intVal
in
The integer value to write.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTSetInt64

Writes a 64-bit integer to a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly written to the database. In the case of a multicolumn database pointer, a call to MimerRTSetMultiColumn must be made after this call in order for the value to be moved from the database pointer local storage to the database.

After the write, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTSetInt64 (

            MimerRTDbp dbp,

            int64_t bigintVal)

dbp
in
The database pointer to write to.
bigintVal
in
The integer value to write.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTSetMultiColumn

Writes a multicolumn database pointer.

Description

This function will read the database pointer local storage and write it to the database.

Parameters

int32_t MimerRTSetMultiColumn (

            MimerRTDbp dbp)

dbp
in
The database pointer to write.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTSetStringL

Writes a null-terminated string to a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly written to the database. In the case of a multicolumn database pointer, a call to MimerRTSetMultiColumn must be made after this call in order for the value to be moved from the database pointer local storage to the database.

After the write, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTSetStringL (

            MimerRTDbp dbp,

            const char *charVal)

dbp
in
The database pointer to write to.
charVal
in

The string to write.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine explicitly uses the Latin-1 character representation (also called ISO 8859-1) without considering any locale settings.

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTSetTimestampC

Writes a null-terminated timestamp to a database pointer.

Description

In the case of a singlecolumn database pointer, the value will be directly written to the database. In the case of a multicolumn database pointer, a call to MimerRTSetMultiColumn must be made after this call in order for the value to be moved from the database pointer local storage to the database.

After the write, the function will increment the current column to the next one in the set.

Parameters

int32_t MimerRTSetTimestampC (

            MimerRTDbp dbp,

            const char *timestamp)

dbp
in
The database pointer to read from.
timestamp
in
The timestamp to write.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine is real-time.

Mimer SQL Auto compatible.

MimerRTUnbindDbp

Deletes a database pointer.

Parameters

int32_t MimerRTUnbindDbp (

            MimerRTDbp *dbp)

dbp
inout
The database pointer to unbind.

Returns

A negative value indicating an error, or zero if successful.

Return value
Description
MIMER_SUCCESS
Success.
< 0
Any of the server error codes listed in Return Codes.

Note

This routine interacts with the database server.

Mimer SQL Auto compatible.


Mimer
Mimer Information Technology AB
Voice: +46 18 780 92 00
Fax: +46 18 780 92 40
info@mimer.se
Mimer SQL Documentation TOC PREV NEXT INDEX