指定されたタイプの入力オブジェクト名のオブジェクト・ハンドルの配列を戻します。または、*pcountがゼロの場合は、すべてのオブジェクト・ハンドルを戻します。
構文
ESS_FUNC_M EssOtlQueryObjects(
hOutline, objType, objNames, pcount, ppObjHandles
)
パラメータ | データ型 | 説明 |
---|---|---|
hOutline |
ESS_HOUTLINE_T |
アウトライン・ハンドル(クエリー・モードのみ) |
objType |
ESS_OBJECT_TYPES |
オブジェクトのタイプ:
|
objNames |
ESS_PSTR_T |
クエリーを実行するオブジェクト名の配列 |
pcount |
ESS_PULONG_T |
オブジェクト名のカウント。pcountがゼロの場合、実行時のテキスト・リスト(SmartList)ハンドルの数が含まれます。 |
ppObjHandles |
ESS_PPHOBJECT_T |
オブジェクト・ハンドルの配列 EssOtlFreeObjectArrayを使用して割り当てる必要があります |
戻り値
戻り値:
0 - 正常終了の場合
pcountには値が含まれます。
エラー番号 - 失敗した場合
pcountはNULLです。
例
void TestFreeObjectArray()
{
ESS_STS_T sts = ESS_STS_NOERR;
ESS_HOUTLINE_T hOutline = ESS_NULL;
ESS_OBJDEF_T Object;
ESS_STR_T objNames[1];
ESS_OBJECT_TYPES objType;
ESS_ULONG_T count;
ESS_PHOBJECT_T hObjHandles = ESS_NULL;
memset(&Object, '\0', sizeof(Object));
Object.hCtx = hCtx;
Object.ObjType = ESS_OBJTYPE_OUTLINE;
Object.AppName = szAppName;
Object.DbName = szDbName;
Object.FileName = szFileName;
/* Set up */
sts = EssOtlOpenOutlineQuery(hCtx, &Object, &hOutline);
count = 2;
objType = OBJECT_SMARTLIST;
objNames[0] = "Smartlist1";
objNames[1] = "Smartlist2";
/* Query objects */
sts =
EssOtlQueryObjects(hOutline, objType,
objNames, &Count, &hObjHandles);
/* Free object array */
if(hObjHandles)
{
sts = EssOtlFreeObjectArray(hOutline, count, hObjHandles);
}
/* Close outline */
sts = EssOtlCloseOutline(hOutline);
}
関連トピック