EssOtlGetMemberCommentEx() gets the extended comment for the specified member.
ESS_FUNC_M EssOtlGetMemberCommentEx (hOutline, hMember, pszCommentEx);
ESS_HOUTLINE_T | hOutline |
ESS_HMEMBER_T | hMember |
ESS_PSTR_T | pszCommentEx |
hOutline | Outline context handle |
hMember | Member handle. |
pszCommentEx | Variable for the return of the extended comment. This buffer is allocated by the API. |
Returns 0 if successful.
#include <essapi.h> #include <essotl.h> ESS_STS_T sts = 0; ESS_OBJDEF_T Object; ESS_HOUTLINE_T hOutline; ESS_HMEMBER_T hMember; ESS_STR_T pszCommentEx = ESS_NULL; 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, "Variance", &hMember); } if (!sts && hMember) { sts = EssOtlGetMemberCommentEx(hOutline, hMember, &pszCommentEx); } if (pszCommentEx) { EssFree(hInst, pszCommentEx); }