PoolExtendH (FUN) ¶ FUNCTION PoolExtendH : ERROR InOut: Scope Name Type Return PoolExtendH ERROR Input hPool CAA.HANDLE ctNumBlocks CAA.COUNT
PoolGetBlock (FUN) ¶ FUNCTION PoolGetBlock : CAA.HANDLE Gets the next available block from hPool and returns ist handle InOut: Scope Name Type Return PoolGetBlock CAA.HANDLE Input hPool CAA.HANDLE peError POINTER TO ERROR
MakeNormed3D (FUN) ¶ FUNCTION MakeNormed3D : BOOL This function will scale an input vector \(v \in \mathbb{R^{3}}\) to norm 1, as far as \(v\) is not the null vector. InOut: Scope Name Type Comment Return MakeNormed3D BOOL TRUE : If \(v\) is not the null vector Input pv POINTER TO VECTOR3D Pointer to input vector \(v \in \mathbb{R^{3}}\)
Norm3D (FUN) ¶ FUNCTION Norm3D : LREAL This function will return the length/norm of a three dimensional vector \(v \in \mathbb{R^{3}}\) InOut: Scope Name Type Comment Return Norm3D LREAL The length/norm of the input vector \(v\) Input pv POINTER TO VECTOR3D Pointer to input vector \(v \in \mathbb{R^{3}}\)
ScalProd3D (FUN) ¶ FUNCTION ScalProd3D : LREAL This function will calculate the scalar product of two vectors \(v_{1}, v_{2} \in \mathbb{R^{3}}\) InOut: Scope Name Type Comment Return ScalProd3D LREAL \(v_{1} \cdot v_{2} \in \mathbb{R}\) Input pv1 POINTER TO Vector3d Pointer to input vector \(v_{1} \in \mathbb{R}\) pv2 POINTER TO Vector3d Pointer to input vector \(v_{2} \in \mathbb{R}\)
ScalProd3DStand (FUN) ¶ FUNCTION ScalProd3DStand : LREAL This function will calculate the cosine of the angle being drawn by two input vectors \(v_{1}, v_{2} \in \mathbb{R^{3}}\) . InOut: Scope Name Type Comment Return ScalProd3DStand LREAL If one of the input vector equals the null vector, 0 will be returned. Input pv1 POINTER TO Vector3d Pointer to input vector \(v_{1} \in \mathbb{R}\) pv2 POINTER TO Vector3d Pointer to input vector \(v_{2} \in \mathbb{R}\)
SubVector (FUN) ¶ FUNCTION SubVector : BOOL This function will subtract two input vectors \(v_{1}, v_{2} \in \mathbb{R^{3}}\) and store the result within vector \(v \in \mathbb{R^{3}}\) : \[v = v_{1}-v_{2}\] InOut: Scope Name Type Comment Return SubVector BOOL The return value is not used. Input pv1 POINTER TO Vector3d Pointer to input vector \(v_{1} \in \mathbb{R}\) pv2 POINTER TO Vector3d Pointer to input vector \(v_{2} \in \mathbb{R}\) pv POINTER TO Vector3D Pointer to output vector \(v \in \mathbb{R}\)
IStorageAsync.StorageCloseAsync (METH) ¶ METHOD StorageCloseAsync : PROC_STATE InOut: Scope Name Type Comment Return StorageCloseAsync PROC_STATE Input eCmd PROC_CMD eCommand Output eError ERROR
IStorageAsync.StorageReorgAsync (METH) ¶ METHOD StorageReorgAsync : PROC_STATE The reorg function rebuilds the entire storgae. There are several reasons an application might do this: Unless the storgae is running with xAutoReorg = TRUE, when a large amount of data is deleted from the storage file it leaves behind empty space, or “free” storage pages. This means the database file might be larger than strictly necessary. Running the reorg function to rebuild the storage reclaims this space and reduces the size of the storage file. Frequent inserts, updates, and deletes can cause the database file to become fragmented - where data for a single table or index is scattered around the storage file. Running the reorg function ensures that each table and index is largely stored contiguously within the storage file. In some cases, the reorg function may also reduce the number of partially filled pages in the database, reducing the size of the database file further. The reorg function works by copying the contents of the database into a temporary storage file and then overwriting the original with the contents of the temporary file. When overwriting the original, a rollback journal or write-ahead log file is used just as it would be for any other storage transaction. This means that when reorganizing a storage, as much as twice the size of the original database file is required in free disk space. The reorg function will fail if there is an open transaction when it is run. InOut: Scope Name Type Comment Return StorageReorgAsync PROC_STATE Input eCmd PROC_CMD eCommand Output eError ERROR
Table ¶ TableOpenAsync (Method)