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

FtpRenameFileW

関数
FTPサーバー上のファイル名を変更する(Unicode版)。
DLLWININET.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FtpRenameFileW(
    void* hConnect,
    LPCWSTR lpszExisting,
    LPCWSTR lpszNew
);

パラメーター

名前方向説明
hConnectvoid*inFTP セッションへのハンドル。
lpszExistingLPCWSTRin名前を変更するファイルの名前を格納した、null で終わる文字列へのポインター。
lpszNewLPCWSTRinリモートファイルの新しい名前を格納した、null で終わる文字列へのポインター。

戻り値の型: BOOL

公式ドキュメント

FTP サーバーに格納されているファイルの名前を変更します。(Unicode)

戻り値

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

解説(Remarks)

lpszExisting および lpszNew パラメーターには、カレントディレクトリからの相対パスとして、部分的に修飾されたファイル名または完全修飾されたファイル名のいずれかを指定できます。

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

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

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

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

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

var (
	wininet = windows.NewLazySystemDLL("WININET.dll")
	procFtpRenameFileW = wininet.NewProc("FtpRenameFileW")
)

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

extern "wininet" fn FtpRenameFileW(
    hConnect: ?*anyopaque, // void*
    lpszExisting: [*c]const u16, // LPCWSTR
    lpszNew: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc FtpRenameFileW(
    hConnect: pointer,  # void*
    lpszExisting: WideCString,  # LPCWSTR
    lpszNew: WideCString  # LPCWSTR
): int32 {.importc: "FtpRenameFileW", stdcall, dynlib: "WININET.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wininet");
extern(Windows)
int FtpRenameFileW(
    void* hConnect,   // void*
    const(wchar)* lpszExisting,   // LPCWSTR
    const(wchar)* lpszNew   // LPCWSTR
);
ccall((:FtpRenameFileW, "WININET.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Cwstring),
      hConnect, lpszExisting, lpszNew)
# hConnect : void* -> Ptr{Cvoid}
# lpszExisting : LPCWSTR -> Cwstring
# lpszNew : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t FtpRenameFileW(
    void* hConnect,
    const uint16_t* lpszExisting,
    const uint16_t* lpszNew);
]]
local wininet = ffi.load("wininet")
-- wininet.FtpRenameFileW(hConnect, lpszExisting, lpszNew)
-- hConnect : void*
-- lpszExisting : LPCWSTR
-- lpszNew : 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 FtpRenameFileW = lib.func('__stdcall', 'FtpRenameFileW', 'int32_t', ['void *', 'str16', 'str16']);
// FtpRenameFileW(hConnect, lpszExisting, lpszNew)
// hConnect : void* -> 'void *'
// lpszExisting : LPCWSTR -> 'str16'
// lpszNew : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WININET.dll", {
  FtpRenameFileW: { parameters: ["pointer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.FtpRenameFileW(hConnect, lpszExisting, lpszNew)
// hConnect : void* -> "pointer"
// lpszExisting : LPCWSTR -> "buffer"
// lpszNew : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FtpRenameFileW(
    void* hConnect,
    const uint16_t* lpszExisting,
    const uint16_t* lpszNew);
C, "WININET.dll");
// $ffi->FtpRenameFileW(hConnect, lpszExisting, lpszNew);
// hConnect : void*
// lpszExisting : LPCWSTR
// lpszNew : 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 FtpRenameFileW(
        Pointer hConnect,   // void*
        WString lpszExisting,   // LPCWSTR
        WString lpszNew   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wininet")]
lib LibWININET
  fun FtpRenameFileW = FtpRenameFileW(
    hConnect : Void*,   # void*
    lpszExisting : UInt16*,   # LPCWSTR
    lpszNew : 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 FtpRenameFileWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>);
typedef FtpRenameFileWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>);
final FtpRenameFileW = DynamicLibrary.open('WININET.dll')
    .lookupFunction<FtpRenameFileWNative, FtpRenameFileWDart>('FtpRenameFileW');
// hConnect : void* -> Pointer<Void>
// lpszExisting : LPCWSTR -> Pointer<Utf16>
// lpszNew : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FtpRenameFileW(
  hConnect: Pointer;   // void*
  lpszExisting: PWideChar;   // LPCWSTR
  lpszNew: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'WININET.dll' name 'FtpRenameFileW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let ftprenamefilew =
  foreign "FtpRenameFileW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* hConnect : void* -> (ptr void) *)
(* lpszExisting : LPCWSTR -> (ptr uint16_t) *)
(* lpszNew : 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 ("FtpRenameFileW" ftp-rename-file-w :convention :stdcall) :int32
  (h-connect :pointer)   ; void*
  (lpsz-existing (:string :encoding :utf-16le))   ; LPCWSTR
  (lpsz-new (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FtpRenameFileW = Win32::API::More->new('WININET',
    'BOOL FtpRenameFileW(LPVOID hConnect, LPCWSTR lpszExisting, LPCWSTR lpszNew)');
# my $ret = $FtpRenameFileW->Call($hConnect, $lpszExisting, $lpszNew);
# hConnect : void* -> LPVOID
# lpszExisting : LPCWSTR -> LPCWSTR
# lpszNew : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い