EssOtlImportExportObject

Imports or exports the contents of the input object to the input file based on bImport being true or false.

Syntax

ESS_FUNC_M EssOtlImportExportObject(hOutline, objHandle, FileName, bImport)
ParameterData TypeDescription

hOutline

ESS_HOUTLINE_T

Outline handle (Edit mode only)

objHandle

ESS_HOBJECT_T

Object handle to be imported or exported

FileName

ESS_STR_T

Name of the file to which object needs to be exported or imported from

bImport

ESS_BOOL_T
  • true

    Import

  • false

    Export

Return Value

Returns:

Example

void TestImportExportObject()
{
	ESS_STS_T				sts = ESS_STS_NOERR;
	ESS_OBJDEF_T			Object;
	ESS_HOUTLINE_T		hOutline = ESS_NULL;
	ESS_HOBJECT_T		hObjHandle = ESS_NULL;
	ESS_PHOBJECT_T		hObjHandles;
	ESS_STR_T				sFileName;
	ESS_BOOL_T			bImport;
	ESS_OBJECT_TYPES	objType;
	ESS_STR_T				objName = "";
	ESS_ULONG_T			Count, i;
	
	memset(&Object, '\0', sizeof(Object)); 
	Object.hCtx = 		hCtx;
	Object.ObjType = 	ESS_OBJTYPE_OUTLINE;
	Object.AppName = 	szAppName;
	Object.DbName = 	szDbName;
	Object.FileName = szFileName;
 
	sts = EssOtlOpenOutline(hCtx, &Object, 
				ESS_TRUE, ESS_TRUE, &hOutline);   
	
	/* Create an object for the test */
	objType = OBJECT_SMARTLIST;
	objName = "CSRatings";

	sts = EssOtlCreateObject(hOutline, objType, 
					objName, &hObjHandle);

	/* Import a SmartList */
	sFileName = "F:\\testArea\\Smartlist\\ImpCSRatingsSL.txt";
	bImport = ESS_TRUE; 
 	sts = EssOtlImportExportObject(hOutline, hObjHandle, 
					sFileName, bImport);
	printf("EssOtlImportExportObject sts: %ld\n",sts);

	/* Verify import results */
	sts = EssOtlListObjects(hOutline, objType, 
					&Count, &hObjHandles);
	for (i = 0; i < Count; i++)
		DisplaySmartListInfo(hOutline, hObjHandles[i]);

	SaveOutline(hOutline);

	printf("\n");
	objName = "CSRatings";
	sts = EssOtlFindObject(hOutline, objType, 
				objName, &hObjHandle);
	printf("EssOtlFindObject sts: %ld\n",sts);

	/* Export a SmartList */
	bImport = ESS_FALSE;
	sFileName = "F:\\testArea\\Smartlist\\ExpCSRatingsSL.txt";
	sts = EssOtlImportExportObject(hOutline, hObjHandle, 
				sFileName, bImport);
	/* Unlock objects */
	sts = EssUnlockObject(hCtx, Object.ObjType, 
				Object.AppName, Object.DbName, Object.FileName); 

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

See Also