EssOtlListObjects

指定されたタイプのすべてのオブジェクト・ハンドルの配列が戻されます。

構文

            ESS_FUNC_M EssOtlListObjects(
            hOutline, objType, pCount, pObjHandles
            )

パラメータ	データ型	説明
hOutline	ESS_HOUTLINE_T	アウトライン・ハンドル(編集モードのみ)
objType	ESS_OBJECT_TYPES	次のいずれかの値を持つオブジェクト・タイプ: OBJECT_SMARTLIST オブジェクト・タイプはテキスト・リスト(スマートリスト)
pCount	ESS_ULONG_T*	オブジェクト・ハンドルのカウント
pObjHandles	ESS_PPHOBJECT_T	オブジェクト・ハンドルの配列が戻されます。EssFreeを使用して割当てを解除する必要があります。

戻り値

戻り値:

0 - 正常終了の場合
pCountおよびpObjHandlesには値が含まれます。
エラー番号 - 失敗した場合
pCountおよびpObjHandlesはNULLです。

例

         void TestCreateObject()
{
    ESS_STS_T           sts = ESS_STS_NOERR;
    ESS_HOUTLINE_T      hOutline = ESS_NULL;
    ESS_OBJDEF_T        Object;
    ESS_OBJECT_TYPES    objType;
    ESS_STR_T           smartListName;
    ESS_HOBJECT_T       ObjHandle;
    ESS_ULONG_T         Count, i;
    ESS_PHOBJECT_T      ObjHandles;
    ESS_HOBJECT_T       hObjHandle;
    ESS_HSMARTLIST_T    hSmartList;
    ESS_STR_T           objName;
   
    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);
   
    /* Create a static SmartList */
    objType = OBJECT_SMARTLIST;
    smartListName = "SList1";
    sts = EssOtlCreateObject(hOutline, objType, 
								smartListName, &ObjHandle);
    /* List all SmartList objects */
    objType = OBJECT_SMARTLIST;
    sts = 
         EssOtlListObjects(hOutline, objType, 
								&Count, &ObjHandles);
         

    /* Save */
    SaveOutline(hOutline);

    /* Find objects */
    objName = "SList1";
    sts = EssOtlFindObject(hOutline, objType, objName, 
											&hObjHandle);

     /* Delete objects */
    hSmartList = (ESS_HSMARTLIST_T)hObjHandle;
    sts = EssOtlDeleteObject(hOutline, hSmartList);
    SaveOutline(hOutline);

    if(ObjHandles)
        EssFree (hInst, ObjHandles);

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

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