クライアント上にある特定のオブジェクト・ファイルの完全なローカル・ファイル・パスを取得します。
構文
ESS_FUNC_M EssGetLocalPath (
hCtx, ObjType, AppName, DbName, ObjName, Create, pPath
);
パラメータ | データ型 | 説明 |
---|---|---|
hCtx |
ESS_HCTX_T |
EssCreateLocalContextで戻されたAPIコンテキスト・ハンドル。 |
ObjType |
ESS_OBJTYPE_T |
オブジェクト・タイプ(単一のタイプのみ)。オブジェクト・タイプのリストは、ビットマスク・データ型(C)を参照してください。 |
AppName |
ESS_STR_T |
アプリケーション名またはNULL (ESS_NULL)。NULLの場合は、この関数がファイル名を想定し、pPathにObjNameをそのまま戻します。 |
DbName |
ESS_STR_T |
データベース名。NULLの場合は、アプリケーション・サブディレクトリを使用します。 |
ObjName |
ESS_STR_T |
オブジェクト名またはファイル名。AppNameがNULLの場合は、ObjNameが正しいかどうか解析されません。パスに接尾辞は追加されません。 |
Create |
ESS_BOOL_T |
ディレクトリ・フラグの作成。TRUEの場合は、必要に応じて適切なアプリケーションとデータベース・サブディレクトリが作成されます。FALSEの場合でディレクトリが存在しない場合は、エラーが発生します。 |
pPath |
ESS_PSTR_T |
割り当てられたローカル・パス名文字列を受け取るポインタのアドレス。 |
備考
pPathに対して割り当てられたメモリーは、EssFreeを使用して解放する必要があります。
戻り値
正常終了の場合、適切なオブジェクト・ファイルのフル・パス名がpPathに戻されます。
アクセス
この関数を使用するのに、特別な権限は必要ありません。
例
ESS_VOID_T ESS_GetLocalPath (ESS_HINST_T hInst) { ESS_FUNC_M sts = ESS_STS_NOERR; ESS_HCTX_T hLocalCtx; ESS_STR_T AppName; ESS_STR_T DbName; ESS_STR_T ObjName; ESS_OBJTYPE_T ObjType; ESS_BOOL_T Create; ESS_STR_T Path; AppName = "Sample"; DbName = "Basic"; ObjName = "Basic"; ObjType = ESS_OBJTYPE_OUTLINE; Create = ESS_TRUE; sts = EssCreateLocalContext(hInst, NULL, NULL, &hLocalCtx); if(!sts && hLocalCtx) { sts = EssGetLocalPath(hLocalCtx, ObjType, AppName, DbName, ObjName, Create, &Path); if(!sts) { if(*Path) { printf("Path: %s\r\n",Path); EssFree(hInst,Path); } } } if(hLocalCtx) sts = EssDeleteLocalContext(hLocalCtx); }
関連トピック