FtpGetFileW 関数 (wininet.h)
FTP サーバーからファイルを取得し、指定したファイル名で格納し、プロセスに新しいローカル ファイルを作成します。
構文
BOOL FtpGetFileW(
[in] HINTERNET hConnect,
[in] LPCWSTR lpszRemoteFile,
[in] LPCWSTR lpszNewFile,
[in] BOOL fFailIfExists,
[in] DWORD dwFlagsAndAttributes,
[in] DWORD dwFlags,
[in] DWORD_PTR dwContext
);
パラメーター
[in] hConnect
FTP セッションへの処理。
[in] lpszRemoteFile
取得するファイルの名前を含む null で終わる文字列へのポインター。
[in] lpszNewFile
ローカル システムで作成されるファイルの名前を含む null で終わる文字列へのポインター。
[in] fFailIfExists
指定した名前のローカル ファイルが既に存在する場合に関数を続行するかどうかを示します。 fFailIfExists が TRUE で、ローカル ファイルが存在する場合、FtpGetFile は失敗します。
[in] dwFlagsAndAttributes
新しいファイルのファイル属性。 このパラメーターには、 CreateFile 関数で使用されるFILE_ATTRIBUTE_* フラグの任意の組み合わせを指定できます。
[in] dwFlags
関数がファイルのダウンロードを処理する方法を制御します。 フラグ値の最初のセットは、転送が行われる条件を示します。 これらの転送型フラグは、キャッシュを制御するフラグの 2 番目のセットと組み合わせて使用できます。
アプリケーションは、これらの転送タイプ値のいずれかを選択できます。
次のフラグは、このファイルのキャッシュの実行方法を決定します。 次のフラグの任意の組み合わせは、転送の種類のフラグと共に使用できます。
[in] dwContext
この検索を任意のアプリケーション データに関連付けるアプリケーション定義値を含む変数へのポインター。 これは、アプリケーションが既に InternetSetStatusCallback を呼び出して状態コールバック関数を設定している場合にのみ使用されます。
戻り値
成功した場合は TRUE 、それ以外の場合 は FALSE を 返します。 特定のエラー メッセージを取得するには、 GetLastError を呼び出します。
注釈
FtpGetFile は、FTP サーバーからのファイルの読み取りとローカルへの保存に関連するすべての簿記とオーバーヘッドを処理する高レベルのルーチンです。 ファイル データのみを取得する必要があるアプリケーション、またはファイル転送を厳密に制御する必要があるアプリケーションでは、 FtpOpenFile 関数と InternetReadFile 関数を使用する必要があります。
dwFlags パラメーターでFTP_TRANSFER_TYPE_ASCIIが指定されている場合、ファイル データの変換により、コントロール文字と書式設定文字がローカルに変換されます。 既定の転送はバイナリ モードで、ファイルはサーバーに格納されているのと同じ形式でダウンロードされます。
lpszRemoteFile と lpszNewFile の両方に、現在のディレクトリに対する相対ファイル名の一部または完全修飾名を指定できます。
WinINet API の他のすべての側面と同様に、この関数を DllMain またはグローバル オブジェクトのコンストラクターとデストラクター内から安全に呼び出すことはできません。
注意
wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして FtpGetFile を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | wininet.h |
| Library | Wininet.lib |
| [DLL] | Wininet.dll |