EssOtlRenameMember

メンバー名を変更します。

構文

            ESS_FUNC_M 
            EssOtlRenameMember
             (
            hOutline, hMember, pszNewMember
            );

パラメータ	データ型	説明
hOutline	ESS_HOUTLINE_T	アウトラインのコンテキスト・ハンドル
hMember	ESS_HMEMBER_T	名前を変更するメンバーのハンドル
pszNewMember	ESS_STR_T	新しいメンバー名

備考

すべての共有メンバー名も変更されます。
この呼出しは、hMemberパラメータが共有メンバーを指す場合には失敗します。
ESS_ATTRMBRDT_STRING型でない、ゼロレベル(リーフ・ノード)属性のメンバーの名前を変更すると、次の値がリセットされます:
- 属性値
- メンバーのロング名、これはESS_ATTRSPECS_T構造体のアウトラインの指定を使用しています
祖先の名前を変更すると、ゼロレベルの属性メンバーのロング名に影響する場合があります。

戻り値

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

OTLAPI_BAD_MBRNAME
OTLAPI_BAD_RENAMESHARE
OTLAPI_ERR_RENAMENAMEUSED

例

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

ESS_STS_T          sts = 0;
ESS_OBJDEF_T       Object;
ESS_HOUTLINE_T     hOutline;
ESS_HMEMBER_T      hMemberJan;
ESS_APPNAME_T      szAppName;
ESS_DBNAME_T       szDbName;
ESS_OBJNAME_T      szFileName;  

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);

if (!sts)
{
   sts = EssOtlFindMember(hOutline, "Jan",
         &hMemberJan);
}

if (!sts && hMemberJan)
{
   sts = EssOtlRenameMember(hOutline, hMemberJan,
         "January prelim");
}