Oracle TimesTen In-Memory Database C開発者およびリファレンス・ガイド

ttUtilAllocEnv

説明

TimesTenユーティリティ・ライブラリ環境ハンドルにメモリーを割り当て、アプリケーションで使用されるTimesTenユーティリティ・ライブラリ・インタフェースを初期化します。アプリケーションでは、他のすべてのTimesTenユーティリティ・ライブラリ関数より前に、ttUtilAllocEnvをコールする必要があります。また、TimesTenユーティリティ・ライブラリ・インタフェースを使用して処理を行う場合は、ttUtilFreeEnvをコールする必要があります。

構文

ttUtilAllocEnv (ttUtilHandle *handle_ptr, char *errBuff,

unsigned int buffLen, unsigned int *errLen);

パラメータ

ttUtilAllocEnv には、次のパラメータがあります。


パラメータ	型	説明
handle_ptr	ttUtilHandle *	TimesTenユーティリティ・ライブラリ環境ハンドルが返される記憶域へのポインタを指定します。
errBuff	char *	エラー・メッセージがある場合に返される、ユーザーが割り当てるバッファ。返されるエラー・メッセージはヌル終端文字列です。エラー・メッセージは、その長さがbuffLen-1を超えると、buffLen-1に切り捨てられます。このパラメータがNULLの場合、buffLenは無視され、TimesTenはコール元のアプリケーションにエラー・メッセージを返しません。
buffLen	unsigned int	バッファerrBuffのサイズを指定します。このパラメータが0（ゼロ）の場合、TimesTenはコール元のアプリケーションにエラー・メッセージを返しません。
errLen	unsigned int *	エラー・メッセージの実際の長さが返される、符号なし整数へのポインタ。NULLの場合、このパラメータは無視されます。

リターン・コード

ttUtilAllocEnvは、次のコード（ttutillib.hで定義されています）を返します。


コード	説明
TTUTIL_SUCCESS	成功時に返します。

これ以外の場合、TimesTen固有のエラー・メッセージ（tt_errCode.hに定義されています）および対応するエラー・メッセージが、コール元によって提供されるバッファに返されます。

例

utilHandleという名前を使用して、TimesTenユーティリティ・ライブラリ環境ハンドルを割り当てて初期化するには、次のように入力します。

char errBuff [256];

int rc;

ttUtilHandle utilHandle;

rc = ttUtilAllocEnv (&utilHandle, errBuff, sizeof(errBuff), NULL);

参照

ttUtilFreeEnv
ttUtilGetErrorCount
ttUtilGetError