ドキュメンテーション センター

  • 評価版
  • 製品アップデート

目次

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

H5O.visit_by_name

場所およびオブジェクト名で指定されたオブジェクトの参照

構文

[status,opdata_out] = H5O.visit_by_name(loc_id,obj_name,index_type,order,iter_func,opdata_in,lapl_id)

説明

[status,opdata_out] = H5O.visit_by_name(loc_id,obj_name,index_type,order,iter_func,opdata_in,lapl_id) は、場所の識別子およびオブジェクト名の組み合わせでオブジェクトを指定します。loc_id は、ファイルまたはファイル内のオブジェクトを指定して、obj_name は、ファイル内のオブジェクトを絶対名または loc_id に相対して指定します。リンク アクセス プロパティ リストは、リンクが関連する場合は、結果に影響を与える可能性があります。

2 つのパラメーターを使用して反復を作成します。index_typeorder です。パラメーター index_type は、使用されるインデックスを指定します。インデックス タイプによりグループ内のリンクのインデックスが付いていない場合は、まずそのインデックスでの並べ替えが行われ、その後で反復が開始します。リンクにインデックスが付いている場合、並べ替えステップは必要ないため、さらに反復の開始が早くなります。有効な値は次のとおりです。

'H5_INDEX_NAME'名前に基づく英数字のインデックス
'H5_INDEX_CRT_ORDER'作成順に基づくインデックス

index_type で渡されるインデックス タイプが、最善の結果が得られる設定であることに注意してください。アプリケーションが作成順の反復を示す値を渡して、作成順に追跡されていないグループに遭遇した場合、名前の英数字順または名前順にグループが反復されます (名前順が HDF5 ライブラリによって使用されるもともとの順番であり、常に使用可能です)。order は、index_type で指定されるインデックスに従ってオブジェクトを検査する順序を指定します。有効な値は次のとおりです。

'H5_ITER_INC'昇順
'H5_ITER_DEC'降順
'H5_ITER_NATIVE'最速で可能な順序

コールバック関数 iter_func は次のようなシグネチャをもたなければなりません。

function [status,opdata_out] = iter_func(group_id,name,opdata_in)

opdata_in はユーザー定義の値または構造体であり、パラメーター iter_func opdata_in の反復の最初のステップに渡されます。反復ステップの opdata_out は、次の反復ステップのために opdata_in を作成します。反復の最後の最終的な opdata_out は、呼び出し元に opdata_out として返されます。

lapl_id は、リンク アクセス プロパティ リストです。既定のリンク アクセス プロパティが許容可能である場合、'H5P_DEFAULT' を使用できます。

iter_func が返す status 値は次のように解釈されます。

ゼロ反復を続行するか、すべてのメンバーが処理されると呼び出し元にステータス値ゼロを返します。
反復を停止して呼び出し元に正のステータス値を返します。
反復を停止して失敗を示すエラーをスローします。

参考

この情報は役に立ちましたか?