EssOtlOpenOutlineQuery

既存のアウトラインを開きます。

構文

            ESS_FUNC_M 
            EssOtlOpenOutlineQuery
             (
            hCtx, pObject, phOutline
            );

パラメータ	データ型	説明
hCtx	ESS_HCTX_T	アウトラインのコンテキスト・ハンドル。有効なサーバー・ログイン・コンテキストである必要があります。
pObject	ESS_POBJDEF_T	開く対象のアウトライン・オブジェクトを定義しているオブジェクト構造体を指すポインタ。現在これは無視されています。アクセス先のデータベースに対してEssSetActive()を呼び出す必要があります。
phOutline	ESS_PHOUTLINE_T	ESS_HOUTLINE_T変数へのポインタ。APIによって設定され、以降のAPI関数に渡されます。

備考

EssOtlQueryMembers()を使用したアウトラインにアクセスする場合は、この関数を使用します。
この関数を呼び出してもアウトラインはダウンロードされず、ファイル全体がメモリーにロードされます。
したがって、多くのアウトラインAPI関数は、この関数呼出しから戻されるhOutlineを処理できません。
この呼出しの後で次の呼出しにアクセスできます。他のすべてのアウトラインAPI呼出しはエラーを戻します。
- EssOtlCloseOutline
- EssOtlGetMemberAlias
- EssOtlGetMemberFormula
- EssOtlGetMemberInfo
- EssOtlGetNextAliasCombination
- EssOtlGetOutlineInfo
- EssOtlGetUserAttributes
- EssOtlGetGenName
- EssOtlGetGenNames
- EssOtlGetLevelName
- EssOtlGetLevelNames
- EssOtlGetMemberLastFormula

戻り値

関数が正常終了した場合、戻り値は0になります。

OTLAPI_BAD_OBJTYPE
OTLAPI_ERR_FILEOPEN
OTLAPI_ERR_FILEIO

例

         #include <essapi.h>
#include <essotl.h>

ESS_STS_T          sts = ESS_STS_NOERR; 
ESS_HOUTLINE_T     hOutline; 
ESS_OBJDEF_T       Object;
ESS_ACCESS_T       Access;
ESS_STR_T          AppName;
ESS_STR_T          DbName;

AppName = "Sample";
DbName = "Basic";

sts = EssSetActive(hCtx, AppName, DbName, &Access);

if ( sts == 0)
{
memset(&Object, '\0', sizeof(Object));
sts = EssOtlOpenOutlineQuery(hCtx, &Object, &hOutline); 
}