EssOtlSetGenName

次元内の特定世代に対して名前を設定します。

構文

            ESS_FUNC_M 
            EssOtlSetGenName
             (
            hOutline, pszDimension, usGen, pszName
            );

パラメータ	データ型	説明
hOutline	ESS_HOUTLINE_T	アウトラインのコンテキスト・ハンドル。
pszDimension	ESS_STR_T	対象の世代を含む次元の名前。
usGen	ESS_USHORT_T	名前を設定する世代の番号。次元自体は世代1です。
pszName	ESS_STR_T	世代に与える名前。

備考

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

戻り値

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

OTLAPI_BAD_GENLEVELNAME
OTLAPI_ERR_GENLEVELNAMEEXISTS
OTLAPI_ERR_GENLEVELEXISTS
OTLAPI_ERR_GENLEVELVALUE
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       GenNum;
ESS_STR_T          GenName;

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 Generation Name  ************/
Dimension = "Year";
GenNum = 2;
GenName = "Qtr123";

if (!sts)
{
   sts = EssOtlSetGenName(hOutline, Dimension,
         GenNum, GenName);
}