ホーム › Networking.WinInet › FtpGetCurrentDirectoryW

FtpGetCurrentDirectoryW

関数

FTPセッションのカレントディレクトリ名を取得する(Unicode版)。

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

シグネチャ

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL FtpGetCurrentDirectoryW(
    void* hConnect,
    LPWSTR lpszCurrentDirectory,
    DWORD* lpdwCurrentDirectory
);

パラメーター

名前	型	方向	説明
hConnect	void*	in	FTP セッションへのハンドル。
lpszCurrentDirectory	LPWSTR	out	現在のディレクトリの絶対パスを受け取る、null で終わる文字列へのポインター。
lpdwCurrentDirectory	DWORD*	inout	バッファーの長さを TCHAR 単位で指定する変数へのポインター。バッファーの長さには、終端の null 文字分の領域を含める必要があります。長さに MAX_PATH を使用すれば、すべてのパスに対して十分です。関数が戻ると、この変数はバッファーにコピーされた文字数を受け取ります。

戻り値の型: BOOL

公式ドキュメント

指定された FTP セッションの現在のディレクトリを取得します。(Unicode)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。具体的なエラーメッセージを取得するには、 GetLastError を呼び出します。

解説(Remarks)

lpszCurrentDirectory バッファーが十分な大きさでない場合、 lpdwCurrentDirectory は完全な現在のディレクトリ名を取得するために必要なバイト数を受け取ります。

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

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

メモ

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

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

各言語での呼び出し定義

// WININET.dll  (Unicode / -W)
#include <windows.h>

BOOL FtpGetCurrentDirectoryW(
    void* hConnect,
    LPWSTR lpszCurrentDirectory,
    DWORD* lpdwCurrentDirectory
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FtpGetCurrentDirectoryW(
    IntPtr hConnect,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszCurrentDirectory,   // LPWSTR out
    ref uint lpdwCurrentDirectory   // DWORD* in/out
);

<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FtpGetCurrentDirectoryW(
    hConnect As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> lpszCurrentDirectory As System.Text.StringBuilder,   ' LPWSTR out
    ByRef lpdwCurrentDirectory As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hConnect : void*
' lpszCurrentDirectory : LPWSTR out
' lpdwCurrentDirectory : DWORD* in/out
Declare PtrSafe Function FtpGetCurrentDirectoryW Lib "wininet" ( _
    ByVal hConnect As LongPtr, _
    ByVal lpszCurrentDirectory As LongPtr, _
    ByRef lpdwCurrentDirectory As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FtpGetCurrentDirectoryW = ctypes.windll.wininet.FtpGetCurrentDirectoryW
FtpGetCurrentDirectoryW.restype = wintypes.BOOL
FtpGetCurrentDirectoryW.argtypes = [
    ctypes.POINTER(None),  # hConnect : void*
    wintypes.LPWSTR,  # lpszCurrentDirectory : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # lpdwCurrentDirectory : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
FtpGetCurrentDirectoryW = Fiddle::Function.new(
  lib['FtpGetCurrentDirectoryW'],
  [
    Fiddle::TYPE_VOIDP,  # hConnect : void*
    Fiddle::TYPE_VOIDP,  # lpszCurrentDirectory : LPWSTR out
    Fiddle::TYPE_VOIDP,  # lpdwCurrentDirectory : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "wininet")]
extern "system" {
    fn FtpGetCurrentDirectoryW(
        hConnect: *mut (),  // void*
        lpszCurrentDirectory: *mut u16,  // LPWSTR out
        lpdwCurrentDirectory: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool FtpGetCurrentDirectoryW(IntPtr hConnect, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszCurrentDirectory, ref uint lpdwCurrentDirectory);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpGetCurrentDirectoryW' -Namespace Win32 -PassThru
# $api::FtpGetCurrentDirectoryW(hConnect, lpszCurrentDirectory, lpdwCurrentDirectory)

#uselib "WININET.dll"
#func global FtpGetCurrentDirectoryW "FtpGetCurrentDirectoryW" wptr, wptr, wptr
; FtpGetCurrentDirectoryW hConnect, varptr(lpszCurrentDirectory), varptr(lpdwCurrentDirectory)   ; 戻り値は stat
; hConnect : void* -> "wptr"
; lpszCurrentDirectory : LPWSTR out -> "wptr"
; lpdwCurrentDirectory : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WININET.dll"
#cfunc global FtpGetCurrentDirectoryW "FtpGetCurrentDirectoryW" sptr, var, var
; res = FtpGetCurrentDirectoryW(hConnect, lpszCurrentDirectory, lpdwCurrentDirectory)
; hConnect : void* -> "sptr"
; lpszCurrentDirectory : LPWSTR out -> "var"
; lpdwCurrentDirectory : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WININET.dll"
#cfunc global FtpGetCurrentDirectoryW "FtpGetCurrentDirectoryW" sptr, sptr, sptr
; res = FtpGetCurrentDirectoryW(hConnect, varptr(lpszCurrentDirectory), varptr(lpdwCurrentDirectory))
; hConnect : void* -> "sptr"
; lpszCurrentDirectory : LPWSTR out -> "sptr"
; lpdwCurrentDirectory : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。