ttUtilFreeEnv

説明

TimesTenユーティリティ・ライブラリ環境ハンドルに関連付けられているメモリーを解放します。

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

必要な権限

なし

構文

ttUtilFreeEnv (ttUtilHandle handle, char* errBuff,
               unsigned int buffLen, unsigned int* errLen)

パラメータ

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

リターン・コード

このユーティリティは、ttutillib.hで定義されている次のコードを返します。

コード	説明
TTUTIL_SUCCESS	成功時に返します。
TTUTIL_INVALID_HANDLE	無効なユーティリティ・ライブラリ・ハンドルが指定されている場合に返します。

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

例

この例では、utilHandleというTimesTenユーティリティ・ライブラリ環境ハンドルを解放します。

char           errBuff [256];
int            rc;
ttUtilHandle   utilHandle;

rc = ttUtilFreeEnv (utilHandle, errBuff, sizeof(errBuff), NULL);

関連項目

• ttUtilAllocEnv
• ttUtilGetError
• ttUtilGetErrorCount