Win32 API 日本語リファレンス
ホームSecurity.Credentials › CredRenameW

CredRenameW

関数
資格情報の対象名を変更する。
DLLADVAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CredRenameW(
    LPCWSTR OldTargetName,
    LPCWSTR NewTargetName,
    CRED_TYPE Type,
    DWORD Flags   // optional
);

パラメーター

名前方向説明
OldTargetNameLPCWSTRin名前を変更する資格情報の現在の名前を含む、null 終端文字列へのポインター。
NewTargetNameLPCWSTRin資格情報の新しい名前を含む、null 終端文字列へのポインター。
TypeCRED_TYPEin名前を変更する資格情報の種類。CRED_TYPE_* で定義される値のいずれかである必要があります。
FlagsDWORDoptional関数の動作を制御するフラグ。現在は予約されており、ゼロである必要があります。

戻り値の型: BOOL

公式ドキュメント

CredRename はサポートされなくなりました。(Unicode)

戻り値

この関数は成功時に TRUE、失敗時に FALSE を返します。より具体的なステータスコードを取得するには、GetLastError 関数を呼び出します。返される可能性のあるステータスコードは次のとおりです。

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

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

BOOL CredRenameW(
    LPCWSTR OldTargetName,
    LPCWSTR NewTargetName,
    CRED_TYPE Type,
    DWORD Flags   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool CredRenameW(
    [MarshalAs(UnmanagedType.LPWStr)] string OldTargetName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string NewTargetName,   // LPCWSTR
    uint Type,   // CRED_TYPE
    uint Flags   // DWORD optional
);
<DllImport("ADVAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CredRenameW(
    <MarshalAs(UnmanagedType.LPWStr)> OldTargetName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> NewTargetName As String,   ' LPCWSTR
    Type As UInteger,   ' CRED_TYPE
    Flags As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' OldTargetName : LPCWSTR
' NewTargetName : LPCWSTR
' Type : CRED_TYPE
' Flags : DWORD optional
Declare PtrSafe Function CredRenameW Lib "advapi32" ( _
    ByVal OldTargetName As LongPtr, _
    ByVal NewTargetName As LongPtr, _
    ByVal Type As Long, _
    ByVal Flags 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

CredRenameW = ctypes.windll.advapi32.CredRenameW
CredRenameW.restype = wintypes.BOOL
CredRenameW.argtypes = [
    wintypes.LPCWSTR,  # OldTargetName : LPCWSTR
    wintypes.LPCWSTR,  # NewTargetName : LPCWSTR
    wintypes.DWORD,  # Type : CRED_TYPE
    wintypes.DWORD,  # Flags : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CredRenameW = Fiddle::Function.new(
  lib['CredRenameW'],
  [
    Fiddle::TYPE_VOIDP,  # OldTargetName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # NewTargetName : LPCWSTR
    -Fiddle::TYPE_INT,  # Type : CRED_TYPE
    -Fiddle::TYPE_INT,  # Flags : DWORD optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "advapi32")]
extern "system" {
    fn CredRenameW(
        OldTargetName: *const u16,  // LPCWSTR
        NewTargetName: *const u16,  // LPCWSTR
        Type: u32,  // CRED_TYPE
        Flags: u32  // DWORD optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool CredRenameW([MarshalAs(UnmanagedType.LPWStr)] string OldTargetName, [MarshalAs(UnmanagedType.LPWStr)] string NewTargetName, uint Type, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CredRenameW' -Namespace Win32 -PassThru
# $api::CredRenameW(OldTargetName, NewTargetName, Type, Flags)
#uselib "ADVAPI32.dll"
#func global CredRenameW "CredRenameW" wptr, wptr, wptr, wptr
; CredRenameW OldTargetName, NewTargetName, Type, Flags   ; 戻り値は stat
; OldTargetName : LPCWSTR -> "wptr"
; NewTargetName : LPCWSTR -> "wptr"
; Type : CRED_TYPE -> "wptr"
; Flags : DWORD optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ADVAPI32.dll"
#cfunc global CredRenameW "CredRenameW" wstr, wstr, int, int
; res = CredRenameW(OldTargetName, NewTargetName, Type, Flags)
; OldTargetName : LPCWSTR -> "wstr"
; NewTargetName : LPCWSTR -> "wstr"
; Type : CRED_TYPE -> "int"
; Flags : DWORD optional -> "int"
; BOOL CredRenameW(LPCWSTR OldTargetName, LPCWSTR NewTargetName, CRED_TYPE Type, DWORD Flags)
#uselib "ADVAPI32.dll"
#cfunc global CredRenameW "CredRenameW" wstr, wstr, int, int
; res = CredRenameW(OldTargetName, NewTargetName, Type, Flags)
; OldTargetName : LPCWSTR -> "wstr"
; NewTargetName : LPCWSTR -> "wstr"
; Type : CRED_TYPE -> "int"
; Flags : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procCredRenameW = advapi32.NewProc("CredRenameW")
)

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

extern "advapi32" fn CredRenameW(
    OldTargetName: [*c]const u16, // LPCWSTR
    NewTargetName: [*c]const u16, // LPCWSTR
    Type: u32, // CRED_TYPE
    Flags: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CredRenameW(
    OldTargetName: WideCString,  # LPCWSTR
    NewTargetName: WideCString,  # LPCWSTR
    Type: uint32,  # CRED_TYPE
    Flags: uint32  # DWORD optional
): int32 {.importc: "CredRenameW", stdcall, dynlib: "ADVAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "advapi32");
extern(Windows)
int CredRenameW(
    const(wchar)* OldTargetName,   // LPCWSTR
    const(wchar)* NewTargetName,   // LPCWSTR
    uint Type,   // CRED_TYPE
    uint Flags   // DWORD optional
);
ccall((:CredRenameW, "ADVAPI32.dll"), stdcall, Int32,
      (Cwstring, Cwstring, UInt32, UInt32),
      OldTargetName, NewTargetName, Type, Flags)
# OldTargetName : LPCWSTR -> Cwstring
# NewTargetName : LPCWSTR -> Cwstring
# Type : CRED_TYPE -> UInt32
# Flags : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t CredRenameW(
    const uint16_t* OldTargetName,
    const uint16_t* NewTargetName,
    uint32_t Type,
    uint32_t Flags);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.CredRenameW(OldTargetName, NewTargetName, Type, Flags)
-- OldTargetName : LPCWSTR
-- NewTargetName : LPCWSTR
-- Type : CRED_TYPE
-- Flags : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const CredRenameW = lib.func('__stdcall', 'CredRenameW', 'int32_t', ['str16', 'str16', 'uint32_t', 'uint32_t']);
// CredRenameW(OldTargetName, NewTargetName, Type, Flags)
// OldTargetName : LPCWSTR -> 'str16'
// NewTargetName : LPCWSTR -> 'str16'
// Type : CRED_TYPE -> 'uint32_t'
// Flags : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  CredRenameW: { parameters: ["buffer", "buffer", "u32", "u32"], result: "i32" },
});
// lib.symbols.CredRenameW(OldTargetName, NewTargetName, Type, Flags)
// OldTargetName : LPCWSTR -> "buffer"
// NewTargetName : LPCWSTR -> "buffer"
// Type : CRED_TYPE -> "u32"
// Flags : DWORD optional -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CredRenameW(
    const uint16_t* OldTargetName,
    const uint16_t* NewTargetName,
    uint32_t Type,
    uint32_t Flags);
C, "ADVAPI32.dll");
// $ffi->CredRenameW(OldTargetName, NewTargetName, Type, Flags);
// OldTargetName : LPCWSTR
// NewTargetName : LPCWSTR
// Type : CRED_TYPE
// Flags : DWORD optional
// 構造体/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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class, W32APIOptions.UNICODE_OPTIONS);
    boolean CredRenameW(
        WString OldTargetName,   // LPCWSTR
        WString NewTargetName,   // LPCWSTR
        int Type,   // CRED_TYPE
        int Flags   // DWORD optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("advapi32")]
lib LibADVAPI32
  fun CredRenameW = CredRenameW(
    OldTargetName : UInt16*,   # LPCWSTR
    NewTargetName : UInt16*,   # LPCWSTR
    Type : UInt32,   # CRED_TYPE
    Flags : UInt32   # DWORD optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CredRenameWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Uint32);
typedef CredRenameWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, int);
final CredRenameW = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<CredRenameWNative, CredRenameWDart>('CredRenameW');
// OldTargetName : LPCWSTR -> Pointer<Utf16>
// NewTargetName : LPCWSTR -> Pointer<Utf16>
// Type : CRED_TYPE -> Uint32
// Flags : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CredRenameW(
  OldTargetName: PWideChar;   // LPCWSTR
  NewTargetName: PWideChar;   // LPCWSTR
  Type: DWORD;   // CRED_TYPE
  Flags: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'CredRenameW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CredRenameW"
  c_CredRenameW :: CWString -> CWString -> Word32 -> Word32 -> IO CInt
-- OldTargetName : LPCWSTR -> CWString
-- NewTargetName : LPCWSTR -> CWString
-- Type : CRED_TYPE -> Word32
-- Flags : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let credrenamew =
  foreign "CredRenameW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* OldTargetName : LPCWSTR -> (ptr uint16_t) *)
(* NewTargetName : LPCWSTR -> (ptr uint16_t) *)
(* Type : CRED_TYPE -> uint32_t *)
(* Flags : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("CredRenameW" cred-rename-w :convention :stdcall) :int32
  (old-target-name (:string :encoding :utf-16le))   ; LPCWSTR
  (new-target-name (:string :encoding :utf-16le))   ; LPCWSTR
  (type :uint32)   ; CRED_TYPE
  (flags :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CredRenameW = Win32::API::More->new('ADVAPI32',
    'BOOL CredRenameW(LPCWSTR OldTargetName, LPCWSTR NewTargetName, DWORD Type, DWORD Flags)');
# my $ret = $CredRenameW->Call($OldTargetName, $NewTargetName, $Type, $Flags);
# OldTargetName : LPCWSTR -> LPCWSTR
# NewTargetName : LPCWSTR -> LPCWSTR
# Type : CRED_TYPE -> DWORD
# Flags : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型