solidDB Help : solidDB reference : solidDB SA: Function reference
  
solidDB SA: Function reference
This topic contains the list of the solidDB SA functions in alphabetic order.
Each description includes the purpose, synopsis, parameters, return value, and comments.
Function synopsis
The declaration synopsis for the function is:
SA_EXPORT_H function(modifier parameter [,...]);
where modifier can be:
SaConnectT*
SaColSearchT*
SaCursorT*
SaDataTypeT*
SaDateT*
SaDfloatT*
SaDynDataT*
SaDynStrT*
SaChSetT
char*
char**
double*
long*
float*
int
int*
unsigned*
void
Parameters are in italics and are described below.
Parameter description
In each function description, parameters are described in a table format. Included in the table is the general usage type of the parameter (described in the next section), as well as the use of the parameter variable in the specific function.
Parameter usage type
The following table shows the possible usage type for solidDB SA parameters. Note that if a parameter is used as a pointer, it contains a second category of usage to specify the ownership of the parameter variable after the call.
 
Usage type
Meaning
in
Indicates the parameter is input.
output
Indicates the parameter is output.
in out
Indicates the parameter is input/output.
take
Applies only to a pointer parameter. It means that the parameter value is taken by the function. The caller cannot reference to the parameter after the function call. The function or an object created in the function is responsible for releasing the parameter when it is no longer needed.
hold
Applies only to a pointer parameter. It means that the function holds the parameter value even after the function call. The caller can reference to the parameter value after the function call and is responsible for releasing the parameter. Typically, this kind of parameter is passed to the constructor of some object which holds the pointer value inside a local data structure. The caller cannot release the parameter until the object that holds the parameter is deleted.
use
Applies only to a pointer parameter. It means that the parameter is just used during the function call. The caller can do whatever it wants with the parameter after the function call. This is the most common type of parameter passing.
ref
Applies only to out parameters. See "Return value" for details.
give
Applies only to out parameters. See "Return value" for details.
Return value
Each function description indicates if the function returns a value and the type of value that is returned. Return values can be one of the following values:
Boolean (TRUE, FALSE),
int (such as 1, 0),
SaRetT (error return codes) such as SA_RC_SUCC. For a list of valid error codes, see Handling database errors.
Pointer (out parameter)
The possible return usage types for pointers are described in the following table:
 
Usage type
Meaning
ref
Indicates the caller can only reference the returned value, but cannot release it. Ensure that the returned value is not used after it is released by the object that returned it.
give
Indicates the function gives the returned value to the caller. The caller is responsible for releasing the returned value.
See
SaArrayFlush
SaArrayInsert
SaColSearchCreate
SaColSearchFree
SaColSearchNext
SaConnect
SaCursorAscending
SaCursorAtleast
SaCursorAtmost
SaCursorBegin
SaCursorClearConstr
SaCursorColData
SaCursorColDate
SaCursorColDateFormat
SaCursorColDfloat
SaCursorColDouble
SaCursorColDynData
SaCursorColDynStr
SaCursorColFloat
SaCursorColInt
SaCursorColLong
SaCursorColNullFlag
SaCursorColStr
SaCursorColTime
SaCursorColTimestamp
SaCursorCreate
SaCursorDelete
SaCursorDescending
SaCursorEnd
SaCursorEqual
SaCursorErrorInfo
SaCursorFree
SaCursorInsert
SaCursorLike
SaCursorNext
SaCursorOpen
SaCursorOrderbyVector
SaCursorPrev
SaCursorReSearch
SaCursorSearch
SaCursorSearchByRowid
SaCursorSearchReset
SaCursorSetLockMode
SaCursorSetPosition
SaCursorSetRowsPerMessage
SaCursorUpdate
SaDateCreate
SaDateFree
SaDateSetAsciiz
SaDateSetTimet
SaDateToAsciiz
SaDateToTimet
SaDefineChSet
SaDfloatCmp
SaDfloatDiff
SaDfloatOverflow
SaDfloatProd
SaDfloatQuot
SaDfloatSetAsciiz
SaDfloatSum
SaDfloatToAsciiz
SaDfloatUnderflow
SaDisconnect
SaDynDataAppend
SaDynDataChLen
SaDynDataClear
SaDynDataCreate
SaDynDataFree
SaDynDataGetData
SaDynDataGetLen
SaDynDataMove
SaDynDataMoveRef
SaDynStrAppend
SaDynStrCreate
SaDynStrFree
SaDynStrMove
SaErrorInfo
SaGeoBlockList
SaGeoDecodeLatitude
SaGeoDecodeLatitudeHigh
SaGeoDecodeLatitudeLow
SaGeoDecodeLongitude
SaGeoDecodeLongitudeHigh
SaGeoDecodeLongitudeLow
SaGeoDecodePrecision
SaGeoEncode
SaGeoHashToBoundary
SaGeoNeighbor
SaGeoNeighborhood
SaGeoNeighbourhoodToBoundary
SaGlobalInit
SaSetDateFormat
SaSetSortBufSize
SaSetSortMaxFiles
SaSetTimeFormat
SaSetTimestampFormat
SaSQLExecDirect
SaTransBegin
SaTransCommit
SaTransRollback
SaUserId