Win32 API 日本語リファレンス
ホーム › NetworkManagement.Rras › RasDeleteEntryA

RasDeleteEntryA

関数
RAS電話帳エントリを削除する(ANSI版)。
DLLRASAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// RASAPI32.dll  (ANSI / -A)
#include <windows.h>

DWORD RasDeleteEntryA(
    LPCSTR param0,   // optional
    LPCSTR param1
);

パラメーター

名前型方向説明
param0LPCSTRinoptional電話帳ファイルのフルパス文字列。NULL指定で既定の電話帳を使用する。
param1LPCSTRin削除する対象エントリ名の文字列。

戻り値の型: DWORD

公式ドキュメント

RasDeleteEntry 関数は、電話帳からエントリを削除します。(ANSI)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は次のいずれかのエラー コード、または ルーティングとリモート アクセスのエラー コード か Winerror.h の値です。

値 意味
ERROR_ACCESS_DENIED
ユーザーに適切な特権がありません。このタスクを実行できるのは管理者のみです。
ERROR_INVALID_NAME
lpszEntry で指定されたエントリ名が存在しません。

解説(Remarks)

次のサンプル コードは、変数 lpszEntry で指定された電話帳のエントリを削除します。

#include <stdio.h>
#include <windows.h>
#include "ras.h"
#include "strsafe.h"

#define PHONE_NUMBER_LENGTH 7
#define DEVICE_NAME_LENGTH 5
#define DEVICE_TYPE_LENGTH 5

DWORD __cdecl wmain(){

    DWORD dwRet = ERROR_SUCCESS;
    LPTSTR lpszEntry = L"RASEntryName";
    LPTSTR lpszphonenumber = L"5555555";
    LPTSTR lpszdevicename = L"Modem";
    LPTSTR lpszdevicetype = RASDT_Modem;

    // RASENTRY 構造体用にヒープ メモリを割り当てる
    LPRASENTRY lpentry = (LPRASENTRY)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RASENTRY));
    if (lpentry == NULL){
        printf("HeapAlloc failed");
        return 0;
       }
  
    // RASENTRY->dwSize メンバーを初期化しないと、以下の RRAS API は失敗します。
    lpentry->dwSize = sizeof(RASENTRY);
    lpentry->dwFramingProtocol = RASFP_Ppp;
    lpentry->dwfOptions = 0;
    lpentry->dwType = RASET_Phone;
    dwRet |= StringCchCopyN(lpentry->szLocalPhoneNumber, RAS_MaxPhoneNumber, lpszphonenumber, PHONE_NUMBER_LENGTH);
    dwRet |= StringCchCopyN(lpentry->szDeviceName, RAS_MaxDeviceName, lpszdevicename, DEVICE_NAME_LENGTH);
    dwRet |= StringCchCopyN(lpentry->szDeviceType, RAS_MaxDeviceType, lpszdevicetype, DEVICE_TYPE_LENGTH);
    if (dwRet != ERROR_SUCCESS){
        wprintf(L"RASENTRY structure initialization failed");
        HeapFree(GetProcessHeap(), 0, lpentry);
        return 0;
    }

    // 新しいエントリの名前を検証する
    dwRet = RasValidateEntryName(NULL, lpszEntry);
    if (dwRet != ERROR_SUCCESS){
        wprintf(L"RasValidateEntryName failed: Error = %d\n", dwRet);
        HeapFree(GetProcessHeap(), 0, lpentry);
        return 0;
    }

    // 新しいエントリを作成し、そのプロパティを設定する
    dwRet = RasSetEntryProperties(NULL, lpszEntry, lpentry, lpentry->dwSize, NULL, 0);
    if (dwRet != ERROR_SUCCESS){
        wprintf(L"RasSetEntryProperties failed: Error = %d\n", dwRet);
        HeapFree(GetProcessHeap(), 0, lpentry);
        return 0;
    }

    // クリーンアップ: 新しいエントリを削除する
    dwRet = RasDeleteEntry(NULL, lpszEntry);
    if (dwRet != ERROR_SUCCESS){
        wprintf(L"RasDeleteEntry failed: Error = %d\n", dwRet);
    }

    HeapFree(GetProcessHeap(), 0, lpentry);
    return 0;
}
メモ

ras.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RasDeleteEntry を定義します。エンコーディングに依存しないエイリアスの使用と、エンコーディングに依存するコードを混在させると、不整合が生じてコンパイル エラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規約 を参照してください。

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

各言語での呼び出し定義

// RASAPI32.dll  (ANSI / -A)
#include <windows.h>

DWORD RasDeleteEntryA(
    LPCSTR param0,   // optional
    LPCSTR param1
);
[DllImport("RASAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RasDeleteEntryA(
    [MarshalAs(UnmanagedType.LPStr)] string param0,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string param1   // LPCSTR
);
<DllImport("RASAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RasDeleteEntryA(
    <MarshalAs(UnmanagedType.LPStr)> param0 As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> param1 As String   ' LPCSTR
) As UInteger
End Function
' param0 : LPCSTR optional
' param1 : LPCSTR
Declare PtrSafe Function RasDeleteEntryA Lib "rasapi32" ( _
    ByVal param0 As String, _
    ByVal param1 As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RasDeleteEntryA = ctypes.windll.rasapi32.RasDeleteEntryA
RasDeleteEntryA.restype = wintypes.DWORD
RasDeleteEntryA.argtypes = [
    wintypes.LPCSTR,  # param0 : LPCSTR optional
    wintypes.LPCSTR,  # param1 : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RASAPI32.dll')
RasDeleteEntryA = Fiddle::Function.new(
  lib['RasDeleteEntryA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # param1 : LPCSTR
  ],
  -Fiddle::TYPE_INT)
#[link(name = "rasapi32")]
extern "system" {
    fn RasDeleteEntryA(
        param0: *const u8,  // LPCSTR optional
        param1: *const u8  // LPCSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RASAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RasDeleteEntryA([MarshalAs(UnmanagedType.LPStr)] string param0, [MarshalAs(UnmanagedType.LPStr)] string param1);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RASAPI32_RasDeleteEntryA' -Namespace Win32 -PassThru
# $api::RasDeleteEntryA(param0, param1)
#uselib "RASAPI32.dll"
#func global RasDeleteEntryA "RasDeleteEntryA" sptr, sptr
; RasDeleteEntryA param0, param1   ; 戻り値は stat
; param0 : LPCSTR optional -> "sptr"
; param1 : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RASAPI32.dll"
#cfunc global RasDeleteEntryA "RasDeleteEntryA" str, str
; res = RasDeleteEntryA(param0, param1)
; param0 : LPCSTR optional -> "str"
; param1 : LPCSTR -> "str"
; DWORD RasDeleteEntryA(LPCSTR param0, LPCSTR param1)
#uselib "RASAPI32.dll"
#cfunc global RasDeleteEntryA "RasDeleteEntryA" str, str
; res = RasDeleteEntryA(param0, param1)
; param0 : LPCSTR optional -> "str"
; param1 : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rasapi32 = windows.NewLazySystemDLL("RASAPI32.dll")
	procRasDeleteEntryA = rasapi32.NewProc("RasDeleteEntryA")
)

// param0 (LPCSTR optional), param1 (LPCSTR)
r1, _, err := procRasDeleteEntryA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(param0))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(param1))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function RasDeleteEntryA(
  param0: PAnsiChar;   // LPCSTR optional
  param1: PAnsiChar   // LPCSTR
): DWORD; stdcall;
  external 'RASAPI32.dll' name 'RasDeleteEntryA';
result := DllCall("RASAPI32\RasDeleteEntryA"
    , "AStr", param0   ; LPCSTR optional
    , "AStr", param1   ; LPCSTR
    , "UInt")   ; return: DWORD
●RasDeleteEntryA(param0, param1) = DLL("RASAPI32.dll", "dword RasDeleteEntryA(char*, char*)")
# 呼び出し: RasDeleteEntryA(param0, param1)
# param0 : LPCSTR optional -> "char*"
# param1 : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "rasapi32" fn RasDeleteEntryA(
    param0: [*c]const u8, // LPCSTR optional
    param1: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) u32;
proc RasDeleteEntryA(
    param0: cstring,  # LPCSTR optional
    param1: cstring  # LPCSTR
): uint32 {.importc: "RasDeleteEntryA", stdcall, dynlib: "RASAPI32.dll".}
pragma(lib, "rasapi32");
extern(Windows)
uint RasDeleteEntryA(
    const(char)* param0,   // LPCSTR optional
    const(char)* param1   // LPCSTR
);
ccall((:RasDeleteEntryA, "RASAPI32.dll"), stdcall, UInt32,
      (Cstring, Cstring),
      param0, param1)
# param0 : LPCSTR optional -> Cstring
# param1 : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t RasDeleteEntryA(
    const char* param0,
    const char* param1);
]]
local rasapi32 = ffi.load("rasapi32")
-- rasapi32.RasDeleteEntryA(param0, param1)
-- param0 : LPCSTR optional
-- param1 : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('RASAPI32.dll');
const RasDeleteEntryA = lib.func('__stdcall', 'RasDeleteEntryA', 'uint32_t', ['str', 'str']);
// RasDeleteEntryA(param0, param1)
// param0 : LPCSTR optional -> 'str'
// param1 : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("RASAPI32.dll", {
  RasDeleteEntryA: { parameters: ["buffer", "buffer"], result: "u32" },
});
// lib.symbols.RasDeleteEntryA(param0, param1)
// param0 : LPCSTR optional -> "buffer"
// param1 : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t RasDeleteEntryA(
    const char* param0,
    const char* param1);
C, "RASAPI32.dll");
// $ffi->RasDeleteEntryA(param0, param1);
// param0 : LPCSTR optional
// param1 : LPCSTR
// 構造体/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 Rasapi32 extends StdCallLibrary {
    Rasapi32 INSTANCE = Native.load("rasapi32", Rasapi32.class, W32APIOptions.ASCII_OPTIONS);
    int RasDeleteEntryA(
        String param0,   // LPCSTR optional
        String param1   // LPCSTR
    );
}
@[Link("rasapi32")]
lib LibRASAPI32
  fun RasDeleteEntryA = RasDeleteEntryA(
    param0 : UInt8*,   # LPCSTR optional
    param1 : UInt8*   # LPCSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RasDeleteEntryANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>);
typedef RasDeleteEntryADart = int Function(Pointer<Utf8>, Pointer<Utf8>);
final RasDeleteEntryA = DynamicLibrary.open('RASAPI32.dll')
    .lookupFunction<RasDeleteEntryANative, RasDeleteEntryADart>('RasDeleteEntryA');
// param0 : LPCSTR optional -> Pointer<Utf8>
// param1 : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RasDeleteEntryA(
  param0: PAnsiChar;   // LPCSTR optional
  param1: PAnsiChar   // LPCSTR
): DWORD; stdcall;
  external 'RASAPI32.dll' name 'RasDeleteEntryA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RasDeleteEntryA"
  c_RasDeleteEntryA :: CString -> CString -> IO Word32
-- param0 : LPCSTR optional -> CString
-- param1 : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rasdeleteentrya =
  foreign "RasDeleteEntryA"
    (string @-> string @-> returning uint32_t)
(* param0 : LPCSTR optional -> string *)
(* param1 : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rasapi32 (t "RASAPI32.dll"))
(cffi:use-foreign-library rasapi32)

(cffi:defcfun ("RasDeleteEntryA" ras-delete-entry-a :convention :stdcall) :uint32
  (param0 :string)   ; LPCSTR optional
  (param1 :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RasDeleteEntryA = Win32::API::More->new('RASAPI32',
    'DWORD RasDeleteEntryA(LPCSTR param0, LPCSTR param1)');
# my $ret = $RasDeleteEntryA->Call($param0, $param1);
# param0 : LPCSTR optional -> LPCSTR
# param1 : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目