EssOtlSetMemberCommentEx

Sets the extended comment for the specified member.

Syntax

ESS_FUNC_M EssOtlSetMemberCommentEx (hOutline, hMember, pszCommentEx);

Parameter	Data Type	Description
hOutline	ESS_HOUTLINE_T	Outline context handle
hMember	ESS_HMEMBER_T	Member handle.
pszCommentEx	ESS_STR_T	Buffer containing the extended comment.

Notes

To delete an extended comment, call this function with an empty string or a null pointer.

Return Value

Returns 0 if successful; OTLAPI_ERR_MBRCOMMENTEXLEN if the comment is too long.

Example

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