EssOtlSetLevelName

次元内の特定レベルに対して名前を設定します。

構文

            ESS_FUNC_M 
            EssOtlSetLevelName
             (
            hOutline, pszDimension, usLevel, pszName
            );

パラメータ	データ型	説明
hOutline	ESS_HOUTLINE_T	アウトラインのコンテキスト・ハンドル。
pszDimension	ESS_STR_T	対象のレベルを含む次元の名前。
usLevel	ESS_USHORT_T	名前を設定するレベルの番号。リーフ・メンバーはレベル0です。
pszName	ESS_STR_T	レベルに与える名前。

備考

レベル名はメンバー名と同じルールに従い、メンバーの名前スペース全体で一意の必要があります。他の世代、レベル、メンバー名、または別名と重複できません。重複した名前を追加しようとすると、エラーが発生します。
個々の特定次元およびレベルが持てる名前は1つです。

戻り値

正常終了の場合は0が戻されます。それ以外の場合は、次のいずれかの値が戻されます:

OTLAPI_BAD_GENLEVELNAME
OTLAPI_ERR_GENLEVELNAMEEXISTS
OTLAPI_ERR_GENLEVELEXISTS
OTLAPI_ERR_NOTADIM
OTLAPI_ ERR_GENLEVELNAMEMBR

例

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

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;

memset(&Object, '\0', sizeof(Object));
Object.hCtx = hCtx;
Object.ObjType = ESS_OBJTYPE_OUTLINE;
strcpy(szAppName, "Sample");
strcpy(szDbName, "Basic");
strcpy(szFileName, "Basic");
Object.AppName  = szAppName;
Object.DbName   = szDbName;
Object.FileName = szFileName;

sts = EssOtlOpenOutline(hCtx, &Object, ESS_TRUE, 
     ESS_TRUE, &hOutline);

/*************  Set Level Name  **************/
Dimension = "Year";
LevelNum = 1;
LevelName = "Qtr 1 2 3";

if (!sts)
{
   sts = EssOtlSetLevelName(hOutline, Dimension,
     LevelNum, LevelName);
}