ホーム › Networking.WinInet › FtpFindFirstFileA

FtpFindFirstFileA

関数

FTPサーバー上のファイル検索を開始し最初の項目を取得する(ANSI版)。

DLLWININET.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WININET.dll  (ANSI / -A)
#include <windows.h>

void* FtpFindFirstFileA(
    void* hConnect,
    LPCSTR lpszSearchFile,   // optional
    WIN32_FIND_DATAA* lpFindFileData,   // optional
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);

パラメーター

名前	型	方向	説明
hConnect	void*	in	InternetConnect から返された FTP セッションへのハンドル。
lpszSearchFile	LPCSTR	inoptional	FTP サーバーのファイルシステムにおける有効なディレクトリパスまたはファイル名を指定する null 終端文字列へのポインター。文字列にはワイルドカードを含めることができますが、空白は許可されません。 lpszSearchFile の値が NULL または空文字列の場合、この関数はサーバー上の現在のディレクトリにある最初のファイルを検索します。
lpFindFileData	WIN32_FIND_DATAA*	outoptional	見つかったファイルまたはディレクトリに関する情報を受け取る WIN32_FIND_DATA 構造体へのポインター。
dwFlags	DWORD	in	この関数の動作を制御します。このパラメーターには、次の値の組み合わせを指定できます。 INTERNET_FLAG_HYPERLINK INTERNET_FLAG_NEED_FILE INTERNET_FLAG_NO_CACHE_WRITE INTERNET_FLAG_RELOAD INTERNET_FLAG_RESYNCHRONIZE
dwContext	UINT_PTR	inoptional	この検索を任意のアプリケーションデータと関連付ける、アプリケーション定義の値を指定する変数へのポインター。このパラメーターは、アプリケーションがすでに InternetSetStatusCallback を呼び出してステータスコールバック関数を設定している場合にのみ使用されます。

戻り値の型: void*

公式ドキュメント

指定された FTP セッションの指定ディレクトリを検索します。ファイルおよびディレクトリのエントリは、WIN32_FIND_DATA 構造体としてアプリケーションに返されます。(ANSI)

戻り値

ディレクトリの列挙が正常に開始された場合は要求に対する有効なハンドルを返し、それ以外の場合は NULL を返します。具体的なエラーメッセージを取得するには、 GetLastError を呼び出します。一致するファイルが見つからなかった場合のように、GetLastError が ERROR_INTERNET_EXTENDED_ERROR を返したときは、 InternetGetLastResponseInfo 関数を呼び出して拡張エラーテキストを取得します。詳細は Handling Errors を参照してください。

解説(Remarks)

FtpFindFirstFile では、 WIN32_FIND_DATA 構造体で返されるファイルの時刻は、協定世界時 (UTC) 形式ではなくローカルのタイムゾーンで表されます。

FtpFindFirstFile は FindFirstFile 関数に似ています。ただし、特定の FTP セッション内で同時に実行できる FtpFindFirstFile は 1 つだけであることに注意してください。したがって、列挙は FTP セッションハンドルと関連付けられます。これは、FTP プロトコルがセッションごとに 1 つのディレクトリ列挙のみを許可しているためです。

FtpFindFirstFile を呼び出した後、 InternetCloseHandle を呼び出すまで、アプリケーションは指定した FTP セッションハンドルに対して再び FtpFindFirstFile を呼び出すことはできません。そのハンドルに対して FtpFindFirstFile を呼び出した場合、関数は ERROR_FTP_TRANSFER_IN_PROGRESS で失敗します。呼び出し側アプリケーションが FtpFindFirstFile によって返された HINTERNET ハンドルの使用を終えた後は、 InternetCloseHandle 関数を使用してそれを閉じる必要があります。

FtpFindFirstFile でディレクトリの列挙を開始した後は、 InternetFindNextFile 関数を使用して列挙を続行できます。

FTP プロトコルには標準的な列挙手段が用意されていないため、ファイルの作成日時など、ファイルに関する一般的な情報の一部が常に利用可能または正確であるとは限りません。このような場合、 FtpFindFirstFile および InternetFindNextFile は、利用可能な情報に基づく最善の推測で取得できない情報を補います。たとえば、作成日や最終アクセス日は、しばしばファイルの更新日と同じになります。

アプリケーションは、 FtpOpenFile と InternetCloseHandle の呼び出しの間に FtpFindFirstFile を呼び出すことはできません。

WinINet API の他のすべての側面と同様に、この関数は DllMain やグローバルオブジェクトのコンストラクター/デストラクター内から安全に呼び出すことはできません。

注意 WinINet はサーバー実装をサポートしていません。また、サービスから使用すべきではありません。サーバー実装やサービスには、Microsoft Windows HTTP Services (WinHTTP) を使用してください。

メモ

wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FtpFindFirstFile を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在させて使用すると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細は Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WININET.dll  (ANSI / -A)
#include <windows.h>

void* FtpFindFirstFileA(
    void* hConnect,
    LPCSTR lpszSearchFile,   // optional
    WIN32_FIND_DATAA* lpFindFileData,   // optional
    DWORD dwFlags,
    UINT_PTR dwContext   // optional
);

[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FtpFindFirstFileA(
    IntPtr hConnect,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string lpszSearchFile,   // LPCSTR optional
    IntPtr lpFindFileData,   // WIN32_FIND_DATAA* optional, out
    uint dwFlags,   // DWORD
    UIntPtr dwContext   // UINT_PTR optional
);

<DllImport("WININET.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FtpFindFirstFileA(
    hConnect As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> lpszSearchFile As String,   ' LPCSTR optional
    lpFindFileData As IntPtr,   ' WIN32_FIND_DATAA* optional, out
    dwFlags As UInteger,   ' DWORD
    dwContext As UIntPtr   ' UINT_PTR optional
) As IntPtr
End Function

' hConnect : void*
' lpszSearchFile : LPCSTR optional
' lpFindFileData : WIN32_FIND_DATAA* optional, out
' dwFlags : DWORD
' dwContext : UINT_PTR optional
Declare PtrSafe Function FtpFindFirstFileA Lib "wininet" ( _
    ByVal hConnect As LongPtr, _
    ByVal lpszSearchFile As String, _
    ByVal lpFindFileData As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwContext As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FtpFindFirstFileA = ctypes.windll.wininet.FtpFindFirstFileA
FtpFindFirstFileA.restype = ctypes.c_void_p
FtpFindFirstFileA.argtypes = [
    ctypes.POINTER(None),  # hConnect : void*
    wintypes.LPCSTR,  # lpszSearchFile : LPCSTR optional
    ctypes.c_void_p,  # lpFindFileData : WIN32_FIND_DATAA* optional, out
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_size_t,  # dwContext : UINT_PTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
FtpFindFirstFileA = Fiddle::Function.new(
  lib['FtpFindFirstFileA'],
  [
    Fiddle::TYPE_VOIDP,  # hConnect : void*
    Fiddle::TYPE_VOIDP,  # lpszSearchFile : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpFindFileData : WIN32_FIND_DATAA* optional, out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_UINTPTR_T,  # dwContext : UINT_PTR optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "wininet")]
extern "system" {
    fn FtpFindFirstFileA(
        hConnect: *mut (),  // void*
        lpszSearchFile: *const u8,  // LPCSTR optional
        lpFindFileData: *mut WIN32_FIND_DATAA,  // WIN32_FIND_DATAA* optional, out
        dwFlags: u32,  // DWORD
        dwContext: usize  // UINT_PTR optional
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WININET.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr FtpFindFirstFileA(IntPtr hConnect, [MarshalAs(UnmanagedType.LPStr)] string lpszSearchFile, IntPtr lpFindFileData, uint dwFlags, UIntPtr dwContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpFindFirstFileA' -Namespace Win32 -PassThru
# $api::FtpFindFirstFileA(hConnect, lpszSearchFile, lpFindFileData, dwFlags, dwContext)

#uselib "WININET.dll"
#func global FtpFindFirstFileA "FtpFindFirstFileA" sptr, sptr, sptr, sptr, sptr
; FtpFindFirstFileA hConnect, lpszSearchFile, varptr(lpFindFileData), dwFlags, dwContext   ; 戻り値は stat
; hConnect : void* -> "sptr"
; lpszSearchFile : LPCSTR optional -> "sptr"
; lpFindFileData : WIN32_FIND_DATAA* optional, out -> "sptr"
; dwFlags : DWORD -> "sptr"
; dwContext : UINT_PTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global FtpFindFirstFileA "FtpFindFirstFileA" sptr, str, var, int, sptr
; res = FtpFindFirstFileA(hConnect, lpszSearchFile, lpFindFileData, dwFlags, dwContext)
; hConnect : void* -> "sptr"
; lpszSearchFile : LPCSTR optional -> "str"
; lpFindFileData : WIN32_FIND_DATAA* optional, out -> "var"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global FtpFindFirstFileA "FtpFindFirstFileA" sptr, str, sptr, int, sptr
; res = FtpFindFirstFileA(hConnect, lpszSearchFile, varptr(lpFindFileData), dwFlags, dwContext)
; hConnect : void* -> "sptr"
; lpszSearchFile : LPCSTR optional -> "str"
; lpFindFileData : WIN32_FIND_DATAA* optional, out -> "sptr"
; dwFlags : DWORD -> "int"
; dwContext : UINT_PTR optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。