EssOtlGetMemberType

Returns the member type of the input outline member.

Syntax

ESS_FUNC_M EssOtlGetMemberType(hOutline, hMember, *pusType)
ParameterData TypeDescription

hOutline

ESS_HOUTLINE_T

Outline handle

hMember

ESS_HMEMBER_T

Outline member handle

*pusType

ESS_USHORT_T

Type of the outline member:

  • ESS_MEMBERTYPE_NUMERIC

    Member type is a numeric.

  • ESS_MEMBERTYPE_SMARTLIST

    Member type is textual and has an associated Text List (SmartList) object.

  • ESS_MEMBERTYPE_DATE

    Member type is date typed.

Return Value

Returns:

Example

void TestGetSetMemberType()
{
	ESS_STS_T					sts = ESS_STS_NOERR;
	ESS_HOUTLINE_T			hOutline = ESS_NULL;
	ESS_OBJDEF_T				Object;
	ESS_HMEMBER_T			hMember;
	ESS_USHORT_T				usMemberType;
	
	memset(&Object, '\0', sizeof(Object)); 
	Object.hCtx = 			hCtx;
	Object.ObjType = 		ESS_OBJTYPE_OUTLINE;
	Object.AppName = 		szAppName;
	Object.DbName = 		szDbName;
	Object.FileName = 		szFileName;
 
	/* Open outline */
	sts = EssOtlOpenOutline(hCtx, &Object, ESS_TRUE, 
				ESS_TRUE, &hOutline);
  
	/* Find a member */
	sts = EssOtlFindMember(hOutline, "Original Price", &hMember);

	/* Get Member Type of an outline that is not member 
		type enabled */	
	/* Get original type */
	sts = EssOtlGetMemberType(hOutline, hMember, &usMemberType);
	DisplayMemberType(usMemberType); /* a display function */
  
	/* Get Member Type of an outline that is member 
		type enabled */
	EnableSmartList(hOutline);

	/* Get original type */
	sts = EssOtlGetMemberType(hOutline, hMember, &usMemberType);
	printf("EssOtlGetMemberType sts: %d\n", sts);
	DisplayMemberType(usMemberType);

	/* Set type to NUMERIC */
	usMemberType = ESS_MEMBERTYPE_NUMERIC;
	sts = EssOtlSetMemberType(hOutline, hMember, usMemberType);
	printf("EssOtlSetMemberType sts: %d\n",sts);

	sts = EssOtlGetMemberType(hOutline, hMember, &usMemberType);
	printf("EssOtlGetMemberType sts: %d\n", sts);
	DisplayMemberType(usMemberType);


	/* Clean up */
	sts = EssUnlockObject(hCtx, Object.ObjType, 
				Object.AppName, Object.DbName, Object.FileName); 

	/* Close outline */
	sts = EssOtlCloseOutline(hOutline);
}

See Also