JetGetObjectInfo Function

適用対象: Windows |Windows Server

JetGetObjectInfo Function

JetGetObjectInfo 関数は、データベース オブジェクトに関する情報を取得します。 現時点では、テーブルのみがサポートされています。 JetGetTableInfo を使用すると、 JetGetObjectInfo よりも多くの情報を取得できます。

    JET_ERR JET_API JetGetObjectInfo(
      __in          JET_SESID sesid,
      __in          JET_DBID dbid,
      __in          JET_OBJTYP objtyp,
      __in_opt      const tchar* szContainerName,
      __in_opt      const tchar* szObjectName,
      __out         void* pvResult,
      __in          unsigned long cbMax,
      __in          unsigned long InfoLevel
    );

パラメーター

sesid

使用するデータベース セッション コンテキスト。

dbid

情報の取得元のデータベース。

objtyp

取得する情報を含む オブジェクト。 現時点では、JET_objtypNilとJET_objtypTableのみがサポートされており、どちらも同じように動作します。 テーブルのみが取得されます。

szContainerName

このパラメーターは将来使用するために予約されており、 NULL を渡します。 情報を取得するオブジェクトの種類の名前。

szObjectName

取得する情報を含むオブジェクトの名前。 InfoLevel で JET_ObjInfoList または JET_ObjInfoListNoStats オプションを使用してすべてのオブジェクトの一覧を取得する場合、この値は NULL または空の文字列にする必要があります。

現在、テーブル名のみがサポートされています。

pvResult

指定した情報を受け取るバッファーへのポインター。

バッファーのサイズ (バイト単位) は cbMax で渡されます。 失敗した場合、 pvResult の内容は未定義です。

pvResult に格納される情報は、InfoLevel によって異なります。

cbMax

pvResult で渡されるバッファーのサイズ (バイト単位)。

InfoLevel

指定したオブジェクトに対して取得する情報の種類を指定します。 pvResult の解釈方法に影響します。

このパラメーターには、次のオプションを設定できます。

戻り値

この関数は、次のいずれかの戻りコードを 使用して、JET_ERR データ型を返します。 考えられる ESE エラーの詳細については、「 拡張ストレージ エンジン エラー と エラー処理パラメーター」を参照してください。

解説

JetGetObjectInfo によって一時テーブル (JET_ObjInfoListやJET_ObjInfoNoStatsなど) が正常に作成された場合、呼び出し元は JetCloseTable を使用して一時テーブルを閉じる役割を担います。

現在、JetGetObjectInfo ではテーブルに関する情報の取得のみがサポートされています。

要件

参照

JET_ERR
JET_GRBIT
JET_OBJTYP
JET_SESID
JET_TABLEID
JET_OBJECTINFO
JET_OBJECTLIST
JetCloseTable
JetGetTableInfo