DeleteProfileA
関数指定ユーザーのプロファイルを削除する(ANSI版)。
シグネチャ
// USERENV.dll (ANSI / -A)
#include <windows.h>
BOOL DeleteProfileA(
LPCSTR lpSidString,
LPCSTR lpProfilePath, // optional
LPCSTR lpComputerName // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpSidString | LPCSTR | in | ユーザーの SID を指定する文字列へのポインター。 |
| lpProfilePath | LPCSTR | inoptional | プロファイルのパスを指定する文字列へのポインター。このパラメーターが NULL の場合、関数はレジストリからパスを取得します。 |
| lpComputerName | LPCSTR | inoptional | プロファイルの削除元となるコンピューターの名前を指定する文字列へのポインター。このパラメーターが NULL の場合、ローカルコンピューター名が使用されます。 注意 Windows Vista 以降では、このパラメーターは NULL でなければなりません。NULL でない場合、この関数はエラーコード ERROR_INVALID_PARAMETER で失敗します。
|
戻り値の型: BOOL
公式ドキュメント
指定したコンピューターからユーザープロファイルおよびユーザーに関連するすべての設定を削除します。ユーザーのプロファイルを削除するには、呼び出し元が管理者権限を持っている必要があります。(ANSI)
戻り値
型: BOOL
成功した場合は TRUE、それ以外の場合は FALSE。拡張エラー情報を取得するには、GetLastError を呼び出します。
解説(Remarks)
DeleteProfile は、ローカルシステムアカウント (S-1-5-18) のセキュリティ識別子 (SID) を渡された場合に失敗することがあります。
メモ
userenv.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DeleteProfile を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USERENV.dll (ANSI / -A)
#include <windows.h>
BOOL DeleteProfileA(
LPCSTR lpSidString,
LPCSTR lpProfilePath, // optional
LPCSTR lpComputerName // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool DeleteProfileA(
[MarshalAs(UnmanagedType.LPStr)] string lpSidString, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string lpProfilePath, // LPCSTR optional
[MarshalAs(UnmanagedType.LPStr)] string lpComputerName // LPCSTR optional
);<DllImport("USERENV.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function DeleteProfileA(
<MarshalAs(UnmanagedType.LPStr)> lpSidString As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> lpProfilePath As String, ' LPCSTR optional
<MarshalAs(UnmanagedType.LPStr)> lpComputerName As String ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpSidString : LPCSTR
' lpProfilePath : LPCSTR optional
' lpComputerName : LPCSTR optional
Declare PtrSafe Function DeleteProfileA Lib "userenv" ( _
ByVal lpSidString As String, _
ByVal lpProfilePath As String, _
ByVal lpComputerName As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
DeleteProfileA = ctypes.windll.userenv.DeleteProfileA
DeleteProfileA.restype = wintypes.BOOL
DeleteProfileA.argtypes = [
wintypes.LPCSTR, # lpSidString : LPCSTR
wintypes.LPCSTR, # lpProfilePath : LPCSTR optional
wintypes.LPCSTR, # lpComputerName : LPCSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USERENV.dll')
DeleteProfileA = Fiddle::Function.new(
lib['DeleteProfileA'],
[
Fiddle::TYPE_VOIDP, # lpSidString : LPCSTR
Fiddle::TYPE_VOIDP, # lpProfilePath : LPCSTR optional
Fiddle::TYPE_VOIDP, # lpComputerName : LPCSTR optional
],
Fiddle::TYPE_INT)#[link(name = "userenv")]
extern "system" {
fn DeleteProfileA(
lpSidString: *const u8, // LPCSTR
lpProfilePath: *const u8, // LPCSTR optional
lpComputerName: *const u8 // LPCSTR optional
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool DeleteProfileA([MarshalAs(UnmanagedType.LPStr)] string lpSidString, [MarshalAs(UnmanagedType.LPStr)] string lpProfilePath, [MarshalAs(UnmanagedType.LPStr)] string lpComputerName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_DeleteProfileA' -Namespace Win32 -PassThru
# $api::DeleteProfileA(lpSidString, lpProfilePath, lpComputerName)#uselib "USERENV.dll"
#func global DeleteProfileA "DeleteProfileA" sptr, sptr, sptr
; DeleteProfileA lpSidString, lpProfilePath, lpComputerName ; 戻り値は stat
; lpSidString : LPCSTR -> "sptr"
; lpProfilePath : LPCSTR optional -> "sptr"
; lpComputerName : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USERENV.dll"
#cfunc global DeleteProfileA "DeleteProfileA" str, str, str
; res = DeleteProfileA(lpSidString, lpProfilePath, lpComputerName)
; lpSidString : LPCSTR -> "str"
; lpProfilePath : LPCSTR optional -> "str"
; lpComputerName : LPCSTR optional -> "str"; BOOL DeleteProfileA(LPCSTR lpSidString, LPCSTR lpProfilePath, LPCSTR lpComputerName)
#uselib "USERENV.dll"
#cfunc global DeleteProfileA "DeleteProfileA" str, str, str
; res = DeleteProfileA(lpSidString, lpProfilePath, lpComputerName)
; lpSidString : LPCSTR -> "str"
; lpProfilePath : LPCSTR optional -> "str"
; lpComputerName : LPCSTR optional -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
userenv = windows.NewLazySystemDLL("USERENV.dll")
procDeleteProfileA = userenv.NewProc("DeleteProfileA")
)
// lpSidString (LPCSTR), lpProfilePath (LPCSTR optional), lpComputerName (LPCSTR optional)
r1, _, err := procDeleteProfileA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpSidString))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpProfilePath))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpComputerName))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction DeleteProfileA(
lpSidString: PAnsiChar; // LPCSTR
lpProfilePath: PAnsiChar; // LPCSTR optional
lpComputerName: PAnsiChar // LPCSTR optional
): BOOL; stdcall;
external 'USERENV.dll' name 'DeleteProfileA';result := DllCall("USERENV\DeleteProfileA"
, "AStr", lpSidString ; LPCSTR
, "AStr", lpProfilePath ; LPCSTR optional
, "AStr", lpComputerName ; LPCSTR optional
, "Int") ; return: BOOL●DeleteProfileA(lpSidString, lpProfilePath, lpComputerName) = DLL("USERENV.dll", "bool DeleteProfileA(char*, char*, char*)")
# 呼び出し: DeleteProfileA(lpSidString, lpProfilePath, lpComputerName)
# lpSidString : LPCSTR -> "char*"
# lpProfilePath : LPCSTR optional -> "char*"
# lpComputerName : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "userenv" fn DeleteProfileA(
lpSidString: [*c]const u8, // LPCSTR
lpProfilePath: [*c]const u8, // LPCSTR optional
lpComputerName: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) i32;proc DeleteProfileA(
lpSidString: cstring, # LPCSTR
lpProfilePath: cstring, # LPCSTR optional
lpComputerName: cstring # LPCSTR optional
): int32 {.importc: "DeleteProfileA", stdcall, dynlib: "USERENV.dll".}pragma(lib, "userenv");
extern(Windows)
int DeleteProfileA(
const(char)* lpSidString, // LPCSTR
const(char)* lpProfilePath, // LPCSTR optional
const(char)* lpComputerName // LPCSTR optional
);ccall((:DeleteProfileA, "USERENV.dll"), stdcall, Int32,
(Cstring, Cstring, Cstring),
lpSidString, lpProfilePath, lpComputerName)
# lpSidString : LPCSTR -> Cstring
# lpProfilePath : LPCSTR optional -> Cstring
# lpComputerName : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t DeleteProfileA(
const char* lpSidString,
const char* lpProfilePath,
const char* lpComputerName);
]]
local userenv = ffi.load("userenv")
-- userenv.DeleteProfileA(lpSidString, lpProfilePath, lpComputerName)
-- lpSidString : LPCSTR
-- lpProfilePath : LPCSTR optional
-- lpComputerName : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USERENV.dll');
const DeleteProfileA = lib.func('__stdcall', 'DeleteProfileA', 'int32_t', ['str', 'str', 'str']);
// DeleteProfileA(lpSidString, lpProfilePath, lpComputerName)
// lpSidString : LPCSTR -> 'str'
// lpProfilePath : LPCSTR optional -> 'str'
// lpComputerName : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USERENV.dll", {
DeleteProfileA: { parameters: ["buffer", "buffer", "buffer"], result: "i32" },
});
// lib.symbols.DeleteProfileA(lpSidString, lpProfilePath, lpComputerName)
// lpSidString : LPCSTR -> "buffer"
// lpProfilePath : LPCSTR optional -> "buffer"
// lpComputerName : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t DeleteProfileA(
const char* lpSidString,
const char* lpProfilePath,
const char* lpComputerName);
C, "USERENV.dll");
// $ffi->DeleteProfileA(lpSidString, lpProfilePath, lpComputerName);
// lpSidString : LPCSTR
// lpProfilePath : LPCSTR optional
// lpComputerName : LPCSTR 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 Userenv extends StdCallLibrary {
Userenv INSTANCE = Native.load("userenv", Userenv.class, W32APIOptions.ASCII_OPTIONS);
boolean DeleteProfileA(
String lpSidString, // LPCSTR
String lpProfilePath, // LPCSTR optional
String lpComputerName // LPCSTR optional
);
}@[Link("userenv")]
lib LibUSERENV
fun DeleteProfileA = DeleteProfileA(
lpSidString : UInt8*, # LPCSTR
lpProfilePath : UInt8*, # LPCSTR optional
lpComputerName : UInt8* # LPCSTR optional
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef DeleteProfileANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
typedef DeleteProfileADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
final DeleteProfileA = DynamicLibrary.open('USERENV.dll')
.lookupFunction<DeleteProfileANative, DeleteProfileADart>('DeleteProfileA');
// lpSidString : LPCSTR -> Pointer<Utf8>
// lpProfilePath : LPCSTR optional -> Pointer<Utf8>
// lpComputerName : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function DeleteProfileA(
lpSidString: PAnsiChar; // LPCSTR
lpProfilePath: PAnsiChar; // LPCSTR optional
lpComputerName: PAnsiChar // LPCSTR optional
): BOOL; stdcall;
external 'USERENV.dll' name 'DeleteProfileA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "DeleteProfileA"
c_DeleteProfileA :: CString -> CString -> CString -> IO CInt
-- lpSidString : LPCSTR -> CString
-- lpProfilePath : LPCSTR optional -> CString
-- lpComputerName : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let deleteprofilea =
foreign "DeleteProfileA"
(string @-> string @-> string @-> returning int32_t)
(* lpSidString : LPCSTR -> string *)
(* lpProfilePath : LPCSTR optional -> string *)
(* lpComputerName : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library userenv (t "USERENV.dll"))
(cffi:use-foreign-library userenv)
(cffi:defcfun ("DeleteProfileA" delete-profile-a :convention :stdcall) :int32
(lp-sid-string :string) ; LPCSTR
(lp-profile-path :string) ; LPCSTR optional
(lp-computer-name :string)) ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $DeleteProfileA = Win32::API::More->new('USERENV',
'BOOL DeleteProfileA(LPCSTR lpSidString, LPCSTR lpProfilePath, LPCSTR lpComputerName)');
# my $ret = $DeleteProfileA->Call($lpSidString, $lpProfilePath, $lpComputerName);
# lpSidString : LPCSTR -> LPCSTR
# lpProfilePath : LPCSTR optional -> LPCSTR
# lpComputerName : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f DeleteProfileW (Unicode版) — 指定ユーザーのプロファイルを削除する(Unicode版)。