AIT_FindFirstFile
機能
ファイル検索ハンドルを開いて、指定したファイル名と名前が一致する最初のファイル名を返します。
形式
bool AIT_FindFirstFile ( string strFileNamePattern, // ファイル名 string strFileName, // 検索されたファイル名 integer nSearchHandle // ファイル検索ハンドル );
引数
strFileNamePattern(入力用)
有効なディレクトリの名前、パスまたはファイル名を指定してください。ワイルドカード(*)も使用できます。文字列がワイルドカード、ピリオド、またはディレクトリ名で終わる場合、ユーザはルートまたはパス上のすべてのサブディレクトリへのアクセス権を持っている必要があります。
strFileName(出力用)
指定したファイル名と一致する、検索されたファイルの名前を受け取る変数を指定してください。関数から制御が戻ると、この変数に検索されたファイルの名前が格納されます。
nSearchHandle(出力用)
AIT_FindNextFileおよびAIT_FindCloseFileへの後続の検索で使用するファイル検索ハンドルを受け取る変数を指定してください。関数から制御が戻ると、この変数にファイル検索ハンドルが格納されます。
戻り値
この関数が正常に処理された場合の戻り値はtrue、そのほかの場合はfalseとなります。関数がfalseを返した場合には、AIT_GetLastErrorを使用して拡張エラーコードを取得できます。AIT_GetLastErrorが返すおそれのあるエラーコードを次に示します。
拡張エラー番号 |
エラーコード |
---|---|
2 |
ERROR_FILE_NOT_FOUND |
3 |
ERROR_PATH_NOT_FOUND |
5 |
ERROR_ACCESS_DENIED |
6 |
ERROR_INVALID_HANDLE |
8 |
ERROR_NOT_ENOUGH_MEMORY |
14 |
ERROR_OUTOFMEMORY |
18 |
ERROR_NO_MORE_FILES |
21 |
ERROR_NOT_READY |
112 |
ERROR_DISK_FULL |
123 |
ERROR_INVALID_NAME |
148 |
ERROR_PATH_BUSY |
1005 |
ERROR_UNRECOGNIZED_VOLUME |
1210 |
ERROR_INVALID_COMPUTERNAME |
1214 |
ERROR_INVALID_NETNAME |
1231 |
ERROR_NETWORK_UNREACHABLE |
注意事項
-
この関数は、ファイルを名前だけで検索します。属性での検索には使用できません。後続の「\」の有無に関係なく、ルートディレクトリをAIT_FindFirstFileのstrFileName入力文字列として指定することはできません。
-
AIT_FindFirstFileによって返されたファイル検索ハンドルを閉じるには、AIT_FindCloseFileを使用してください。