次元内の特定のレベルについて、メンバー名の一意性の設定を戻します。
構文
ESS_FUNC_M EssOtlGetLevelNameEx ( hOutline, pszDimension, usLevel, pszName, pbNameUnique );
パラメータ | データ型 | 説明 |
---|---|---|
hOutline |
ESS_HOUTLINE_T |
アウトラインのコンテキスト・ハンドル。 |
pszDimension |
ESS_STR_T |
対象の世代を含む次元の名前。 |
usLevel |
ESS_USHORT_T |
名前を取得するレベル番号の番号。リーフ・メンバーはレベル0です。 |
pszName |
ESS_PSTR_T |
指定された次元のレベルを戻すためのバッファ。APIによって割り当てられます(出力)。 |
pbNameUnique |
ESS_PBOOL_T |
メンバー名の一意性の設定(出力)。 |
備考
Cプログラムでは、戻りバッファを解放する場合はEssFree()を呼び出します。
レベル名は自動的には割り当てられません。この関数で名前を戻すには、名前を割り当てておく必要があります。名前はEssOtlSetLevelNameで割り当てられます
この関数はレベルのメンバー名の一意性情報を取得します。メンバー名の一意性設定を変更するには、EssOtlSetLevelNameExを使用します。
戻り値
正常終了の場合は0が戻されます。それ以外はエラー・コードが戻されます。
例
ESS_FUNC_M
ESS_GetLevelNameEx()
{
ESS_STS_T sts = 0;
ESS_HOUTLINE_T hOutline;
ESS_OBJDEF_T Object;
ESS_APPNAME_T szAppName;
ESS_DBNAME_T szDbName;
ESS_OBJNAME_T szFileName;
ESS_STR_T Dimension;
ESS_USHORT_T LevelNum;
ESS_STR_T LevelName;
ESS_BOOL_T bUnique= ESS_FALSE;
memset(&Object, '\0', sizeof(Object));
Object.hCtx = hCtx;
Object.ObjType = ESS_OBJTYPE_OUTLINE;
strcpy(szAppName, "Demo");
strcpy(szDbName, "Test");
strcpy(szFileName, "Test");
Object.AppName = szAppName;
Object.DbName = szDbName;
Object.FileName = szFileName;
sts = EssOtlOpenOutline(hCtx, &Object, ESS_TRUE,
ESS_TRUE, &hOutline);
/*************** Set and Get Level Name **************/
Dimension = "Year";
LevelNum = 0;
LevelName = "Level 0 Year";
//SetLevelNameEx() so that level 0 member of Year cannot be non-unique
if (!sts)
{
sts = EssOtlSetLevelNameEx(hOutline, Dimension,
LevelNum, LevelName, ESS_TRUE);
}
// GetLevelNameEx() to see if the level is able to be non-unique
if (!sts)
{
sts =
EssOtlGetLevelNameEx
(hOutline, Dimension,
LevelNum, &LevelName, &bUnique);
printf("Level 0 members of Year have bUnique value of %ld\n", bUnique);
}
if (!sts && LevelName)
{
printf("Level Name: %s\n",LevelName);
EssFree(hInst, LevelName);
}
return (sts);
}
関連トピック