Platform SDK: DirectX

IDirectMusicLoader::SetSearchDirectory

IDirectMusicLoader::SetSearchDirectory メソッドは、オブジェクトファイルを検索するための検索パスを設定する。1 つのオブジェクト タイプ、またはすべてのファイルに対する検索パスを設定できる。

HRESULT SetSearchDirectory(
  REFGUID rguidClass,
  WCHAR* pwszPath,
  BOOL fClear
);

パラメータ

rguidClass
呼び出しに関係のあるオブジェクトのクラス識別子への参照 (C++) またはアドレス (C)。GUID_DirectMusicAllTypes は、すべてのタイプを指定する。
pwszPath
ディレクトリのファイルパス。長さが MAX_PATH 以下の有効なディレクトリ名でなければならない。
fClear
TRUE の場合、ディレクトリを設定する前に、オブジェクトに関するすべての情報を消去する。この結果、同じ名前を持つ他のディレクトリにあるオブジェクトへのアクセスを回避できる。ただし、それらのオブジェクトはキャッシュから削除されるわけではない。

戻り値

成功すれば S_OK を返す。検索ディレクトリが既に pwszPath に設定されている場合は S_FALSE を返す。

失敗すれば次のエラー値のいずれかを返す。

E_OUTOFMEMORY
E_POINTER
DMUS_E_LOADER_BADPATH

注意

検索パスを設定した後、ローダーはファイル名を使ってオブジェクトをロードするときに、フルパス名を必要としない。この結果、オブジェクトはフル パスを把握していなくても他のオブジェクトを参照できる。

動作環境

  Windows NT/2000 : Windows 2000 が必要。
  Windows 95/98 : Windows 95 以降が必要。Windows 95 用に再配布可能な形で使用可能。
  ヘッダー : dmusici.h で宣言。

参照

IDirectMusicLoader::ScanDirectoryローダーの検索ディレクトリの設定