EssOtlSetMemberCommentEx

指定したメンバーに対して、拡張コメントを設定します。

構文

            ESS_FUNC_M 
            EssOtlSetMemberCommentEx
             (
            hOutline, hMember, pszCommentEx
            );

パラメータ	データ型	説明
hOutline	ESS_HOUTLINE_T	アウトラインのコンテキスト・ハンドル
hMember	ESS_HMEMBER_T	メンバーのハンドル。
pszCommentEx	ESS_STR_T	拡張コメントを含むバッファ。

備考

拡張コメントを削除するには、空の文字列またはNULLポインタを使用してこの関数を呼び出します。

戻り値

正常終了の場合は0が戻され、コメントが長すぎる場合は、OTLAPI_ERR_MBRCOMMENTEXLENが戻されます。

例

         #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_HMEMBER_T     hMember;      
ESS_STR_T         pszCommentEx; 

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 Extended Member Comment *************/
pszCommentEx = "EXTENDED MEMBER COMMENT";

if (!sts)
{
   sts = EssOtlFindMember(hOutline, "Variance",&hMember);
}

if (!sts && hMember)
{
   sts = EssOtlSetMemberCommentEx(hOutline, hMember, pszCommentEx);
}