Win32 API 日本語リファレンス
ホームNetworking.WinInet › FtpSetCurrentDirectoryW

FtpSetCurrentDirectoryW

関数
FTPセッションのカレントディレクトリを変更する(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FtpSetCurrentDirectoryW(
    void* hConnect,
    LPCWSTR lpszDirectory
);

パラメーター

名前方向説明
hConnectvoid*inFTP セッションへのハンドルです。
lpszDirectoryLPCWSTRinカレント作業ディレクトリにするディレクトリの名前を含む、null で終わる文字列へのポインターです。これは完全修飾パス、またはカレントディレクトリからの相対名のいずれかを指定できます。

戻り値の型: BOOL

公式ドキュメント

FTP サーバー上で別の作業ディレクトリに変更します。(Unicode)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。特定のエラーメッセージを取得するには、 GetLastError を呼び出します。エラーメッセージが、FTP サーバーがディレクトリ変更の要求を拒否したことを示している場合は、 InternetGetLastResponseInfo を使用して理由を判別します。

解説(Remarks)

アプリケーションは、リモートシステムがディレクトリに対して階層的な命名方式を使用していると仮定するのではなく、 FtpGetCurrentDirectory を使用してリモートサイトのカレント作業ディレクトリを判別する必要があります。

lpszDirectory パラメーターには、カレントディレクトリからの相対的な部分修飾または完全修飾のファイル名のいずれかを指定できます。

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

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

wininet.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FtpSetCurrentDirectory を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、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 FtpSetCurrentDirectoryW(
    void* hConnect,
    LPCWSTR lpszDirectory
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WININET.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FtpSetCurrentDirectoryW(
    IntPtr hConnect,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] string lpszDirectory   // LPCWSTR
);
<DllImport("WININET.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FtpSetCurrentDirectoryW(
    hConnect As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> lpszDirectory As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hConnect : void*
' lpszDirectory : LPCWSTR
Declare PtrSafe Function FtpSetCurrentDirectoryW Lib "wininet" ( _
    ByVal hConnect As LongPtr, _
    ByVal lpszDirectory As LongPtr) 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

FtpSetCurrentDirectoryW = ctypes.windll.wininet.FtpSetCurrentDirectoryW
FtpSetCurrentDirectoryW.restype = wintypes.BOOL
FtpSetCurrentDirectoryW.argtypes = [
    ctypes.POINTER(None),  # hConnect : void*
    wintypes.LPCWSTR,  # lpszDirectory : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WININET.dll')
FtpSetCurrentDirectoryW = Fiddle::Function.new(
  lib['FtpSetCurrentDirectoryW'],
  [
    Fiddle::TYPE_VOIDP,  # hConnect : void*
    Fiddle::TYPE_VOIDP,  # lpszDirectory : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wininet")]
extern "system" {
    fn FtpSetCurrentDirectoryW(
        hConnect: *mut (),  // void*
        lpszDirectory: *const u16  // LPCWSTR
    ) -> 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 FtpSetCurrentDirectoryW(IntPtr hConnect, [MarshalAs(UnmanagedType.LPWStr)] string lpszDirectory);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WININET_FtpSetCurrentDirectoryW' -Namespace Win32 -PassThru
# $api::FtpSetCurrentDirectoryW(hConnect, lpszDirectory)
#uselib "WININET.dll"
#func global FtpSetCurrentDirectoryW "FtpSetCurrentDirectoryW" wptr, wptr
; FtpSetCurrentDirectoryW hConnect, lpszDirectory   ; 戻り値は stat
; hConnect : void* -> "wptr"
; lpszDirectory : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WININET.dll"
#cfunc global FtpSetCurrentDirectoryW "FtpSetCurrentDirectoryW" sptr, wstr
; res = FtpSetCurrentDirectoryW(hConnect, lpszDirectory)
; hConnect : void* -> "sptr"
; lpszDirectory : LPCWSTR -> "wstr"
; BOOL FtpSetCurrentDirectoryW(void* hConnect, LPCWSTR lpszDirectory)
#uselib "WININET.dll"
#cfunc global FtpSetCurrentDirectoryW "FtpSetCurrentDirectoryW" intptr, wstr
; res = FtpSetCurrentDirectoryW(hConnect, lpszDirectory)
; hConnect : void* -> "intptr"
; lpszDirectory : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procFtpSetCurrentDirectoryW = wininet.NewProc("FtpSetCurrentDirectoryW")
)

// hConnect (void*), lpszDirectory (LPCWSTR)
r1, _, err := procFtpSetCurrentDirectoryW.Call(
	uintptr(hConnect),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpszDirectory))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FtpSetCurrentDirectoryW(
  hConnect: Pointer;   // void*
  lpszDirectory: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpSetCurrentDirectoryW';
result := DllCall("WININET\FtpSetCurrentDirectoryW"
    , "Ptr", hConnect   ; void*
    , "WStr", lpszDirectory   ; LPCWSTR
    , "Int")   ; return: BOOL
●FtpSetCurrentDirectoryW(hConnect, lpszDirectory) = DLL("WININET.dll", "bool FtpSetCurrentDirectoryW(void*, char*)")
# 呼び出し: FtpSetCurrentDirectoryW(hConnect, lpszDirectory)
# hConnect : void* -> "void*"
# lpszDirectory : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "wininet" fn FtpSetCurrentDirectoryW(
    hConnect: ?*anyopaque, // void*
    lpszDirectory: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc FtpSetCurrentDirectoryW(
    hConnect: pointer,  # void*
    lpszDirectory: WideCString  # LPCWSTR
): int32 {.importc: "FtpSetCurrentDirectoryW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wininet");
extern(Windows)
int FtpSetCurrentDirectoryW(
    void* hConnect,   // void*
    const(wchar)* lpszDirectory   // LPCWSTR
);
ccall((:FtpSetCurrentDirectoryW, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring),
      hConnect, lpszDirectory)
# hConnect : void* -> Ptr{Cvoid}
# lpszDirectory : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t FtpSetCurrentDirectoryW(
    void* hConnect,
    const uint16_t* lpszDirectory);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpSetCurrentDirectoryW(hConnect, lpszDirectory)
-- hConnect : void*
-- lpszDirectory : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WININET.dll');
const FtpSetCurrentDirectoryW = lib.func('__stdcall', 'FtpSetCurrentDirectoryW', 'int32_t', ['void *', 'str16']);
// FtpSetCurrentDirectoryW(hConnect, lpszDirectory)
// hConnect : void* -> 'void *'
// lpszDirectory : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  FtpSetCurrentDirectoryW: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.FtpSetCurrentDirectoryW(hConnect, lpszDirectory)
// hConnect : void* -> "pointer"
// lpszDirectory : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FtpSetCurrentDirectoryW(
    void* hConnect,
    const uint16_t* lpszDirectory);
C, "WININET.dll");
// $ffi->FtpSetCurrentDirectoryW(hConnect, lpszDirectory);
// hConnect : void*
// lpszDirectory : LPCWSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wininet extends StdCallLibrary {
    Wininet INSTANCE = Native.load("wininet", Wininet.class, W32APIOptions.UNICODE_OPTIONS);
    boolean FtpSetCurrentDirectoryW(
        Pointer hConnect,   // void*
        WString lpszDirectory   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wininet")]
lib LibWININET
  fun FtpSetCurrentDirectoryW = FtpSetCurrentDirectoryW(
    hConnect : Void*,   # void*
    lpszDirectory : UInt16*   # LPCWSTR
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FtpSetCurrentDirectoryWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>);
typedef FtpSetCurrentDirectoryWDart = int Function(Pointer<Void>, Pointer<Utf16>);
final FtpSetCurrentDirectoryW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<FtpSetCurrentDirectoryWNative, FtpSetCurrentDirectoryWDart>('FtpSetCurrentDirectoryW');
// hConnect : void* -> Pointer<Void>
// lpszDirectory : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FtpSetCurrentDirectoryW(
  hConnect: Pointer;   // void*
  lpszDirectory: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpSetCurrentDirectoryW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FtpSetCurrentDirectoryW"
  c_FtpSetCurrentDirectoryW :: Ptr () -> CWString -> IO CInt
-- hConnect : void* -> Ptr ()
-- lpszDirectory : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ftpsetcurrentdirectoryw =
  foreign "FtpSetCurrentDirectoryW"
    ((ptr void) @-> (ptr uint16_t) @-> returning int32_t)
(* hConnect : void* -> (ptr void) *)
(* lpszDirectory : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wininet (t "WININET.dll"))
(cffi:use-foreign-library wininet)

(cffi:defcfun ("FtpSetCurrentDirectoryW" ftp-set-current-directory-w :convention :stdcall) :int32
  (h-connect :pointer)   ; void*
  (lpsz-directory (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FtpSetCurrentDirectoryW = Win32::API::More->new('WININET',
    'BOOL FtpSetCurrentDirectoryW(LPVOID hConnect, LPCWSTR lpszDirectory)');
# my $ret = $FtpSetCurrentDirectoryW->Call($hConnect, $lpszDirectory);
# hConnect : void* -> LPVOID
# lpszDirectory : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い