EssOtlSetUserAttribute

メンバーに対するユーザー定義属性を設定します。

構文

            ESS_FUNC_M 
            EssOtlSetUserAttribute
             (
            hOutline, hMember, pszString
            );

パラメータ	データ型	説明
hOutline	ESS_HOUTLINE_T	アウトラインのコンテキスト・ハンドル。
hMember	ESS_HMEMBER_T	ユーザー定義属性を設定するメンバーのハンドル。
pszString	ESS_STR_T	設定するユーザー定義属性。

備考

呼出し元はメンバーに任意の数のユーザー定義属性を設定できます。一意に渡された文字列が各属性を定義し、ユーザー名と同様の表記規則に従います。EssOtlGetUserAttributesを参照してください。
共有メンバーに対してユーザー属性を設定しようとすると、エラーが発生します。

戻り値

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

OTLAPI_BAD_USERATTR
OTLAPI_ERR_SHAREUDA

例

         #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          AttributeList;

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 User Attributes ************/
AttributeList = "Read Write";

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

if (!sts && hMember)
{
   sts = EssOtlSetUserAttribute(hOutline, hMember,
         AttributeList);
}