RasEntryDlgA
関数シグネチャ
// RASDLG.dll (ANSI / -A)
#include <windows.h>
BOOL RasEntryDlgA(
LPSTR lpszPhonebook, // optional
LPSTR lpszEntry, // optional
RASENTRYDLGA* lpInfo
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| lpszPhonebook | LPSTR | inoptional | 電話帳 (PBK) ファイルの完全なパスとファイル名を指定する null 終端文字列へのポインターです。このパラメーターが NULL の場合、関数は現在の既定の電話帳ファイルを使用します。既定の電話帳ファイルは、ダイヤルアップ ネットワーク ダイアログボックスの ユーザー設定 プロパティシートでユーザーが選択したものです。 |
| lpszEntry | LPSTR | inoptional | 編集、コピー、または作成する電話帳エントリの名前を指定する null 終端文字列へのポインターです。 エントリを編集またはコピーする場合、このパラメーターは既存の電話帳エントリの名前です。エントリをコピーする場合は、 RASENTRYDLG 構造体の dwFlags メンバーに RASEDFLAG_CloneEntry フラグを設定します。 メモ RASEDFLAG_CloneEntry フラグは、
Windows Vista および Windows Server 2008 以降では非推奨です。以降のバージョンでは変更されるか、使用できなくなる可能性があります。代わりに、RasGetEntryProperties を呼び出してエントリを取得し、続いて RasSetEntryProperties を呼び出して新しい名前でエントリを保存することにより、エントリをコピーしてください。
|
| lpInfo | RASENTRYDLGA* | inout | 追加の入力パラメーターと出力パラメーターを指定する RASENTRYDLG 構造体へのポインターです。この構造体の dwSize メンバーには、sizeof(RASENTRYDLG) を指定する必要があります。エントリを作成するのか、編集するのか、コピーするのかを示すには、dwFlags メンバーを使用します。エラーが発生した場合、dwError メンバーにエラーコードが返されます。それ以外の場合は 0 が返されます。 |
戻り値の型: BOOL
公式ドキュメント
RasEntryDlg 関数は、ユーザーが電話帳エントリを操作できるようにするモーダルのプロパティシートを表示します。(ANSI)
戻り値
ユーザーが電話帳エントリを作成、コピー、または編集した場合、戻り値は TRUE です。それ以外の場合、関数は FALSE を返します。
エラーが発生した場合、RasEntryDlg は RASENTRYDLG 構造体の dwError メンバーに、Routing and Remote Access Error Codes または Winerror.h の値を設定します。
解説(Remarks)
RasCreatePhonebookEntry 関数と RasEditPhonebookEntry 関数は、 RasEntryDlg 関数を呼び出します。
次のサンプルコードは、新しいエントリを作成するためのプロパティシートを表示します。lpszEntry 変数は、新しいエントリの既定の名前を指定します。
#include <windows.h>
#include <stdio.h>
#include "ras.h"
#include "rasdlg.h"
#include <tchar.h>
DWORD __cdecl wmain(){
DWORD dwRet = ERROR_SUCCESS;
BOOL nRet = TRUE;
LPTSTR lpszEntry = L"EntryName";
// ヒープメモリを割り当て、RASENTRYDLG 構造体を初期化する
LPRASENTRYDLG lpEntry = (LPRASENTRYDLG)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(RASENTRYDLG));
if (lpEntry == NULL){
wprintf(L"HeapAlloc failed.
");
return 0;
}
// RASENTRYDLG->dwSize メンバーを初期化しないと、以降の RRAS API は失敗する。
lpEntry->dwSize = sizeof(RASENTRYDLG);
lpEntry->dwFlags |= RASEDFLAG_NewEntry;
// ユーザーダイアログを使って新しいエントリを作成する
nRet = RasEntryDlg(NULL, lpszEntry, lpEntry);
// エラーコードは lpEntry に返される
dwRet = lpEntry->dwError;
if (nRet == TRUE) {
wprintf(L"New entry created: %s
", lpEntry->szEntry);
// 後始末: 作成したエントリを削除する
dwRet = RasDeleteEntry(NULL, lpszEntry);
if (dwRet != ERROR_SUCCESS) {
wprintf(L"RasDeleteEntry failed: Error = %d
", dwRet);
}
}
else {
if (dwRet != ERROR_SUCCESS) {
wprintf(L"RasEntryDlg failed: Error = %d
", dwRet);
}
else {
wprintf(L"User pressed Cancel
");
}
}
HeapFree(GetProcessHeap(), 0, lpEntry);
return 0;
}
rasdlg.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RASENTRYDLG を定義します。エンコーディング非依存のエイリアスと、エンコーディング非依存でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因になることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// RASDLG.dll (ANSI / -A)
#include <windows.h>
BOOL RasEntryDlgA(
LPSTR lpszPhonebook, // optional
LPSTR lpszEntry, // optional
RASENTRYDLGA* lpInfo
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("RASDLG.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool RasEntryDlgA(
[MarshalAs(UnmanagedType.LPStr)] string lpszPhonebook, // LPSTR optional
[MarshalAs(UnmanagedType.LPStr)] string lpszEntry, // LPSTR optional
IntPtr lpInfo // RASENTRYDLGA* in/out
);<DllImport("RASDLG.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RasEntryDlgA(
<MarshalAs(UnmanagedType.LPStr)> lpszPhonebook As String, ' LPSTR optional
<MarshalAs(UnmanagedType.LPStr)> lpszEntry As String, ' LPSTR optional
lpInfo As IntPtr ' RASENTRYDLGA* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' lpszPhonebook : LPSTR optional
' lpszEntry : LPSTR optional
' lpInfo : RASENTRYDLGA* in/out
Declare PtrSafe Function RasEntryDlgA Lib "rasdlg" ( _
ByVal lpszPhonebook As String, _
ByVal lpszEntry As String, _
ByVal lpInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
RasEntryDlgA = ctypes.windll.rasdlg.RasEntryDlgA
RasEntryDlgA.restype = wintypes.BOOL
RasEntryDlgA.argtypes = [
wintypes.LPCSTR, # lpszPhonebook : LPSTR optional
wintypes.LPCSTR, # lpszEntry : LPSTR optional
ctypes.c_void_p, # lpInfo : RASENTRYDLGA* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('RASDLG.dll')
RasEntryDlgA = Fiddle::Function.new(
lib['RasEntryDlgA'],
[
Fiddle::TYPE_VOIDP, # lpszPhonebook : LPSTR optional
Fiddle::TYPE_VOIDP, # lpszEntry : LPSTR optional
Fiddle::TYPE_VOIDP, # lpInfo : RASENTRYDLGA* in/out
],
Fiddle::TYPE_INT)#[link(name = "rasdlg")]
extern "system" {
fn RasEntryDlgA(
lpszPhonebook: *mut u8, // LPSTR optional
lpszEntry: *mut u8, // LPSTR optional
lpInfo: *mut RASENTRYDLGA // RASENTRYDLGA* in/out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("RASDLG.dll", CharSet = CharSet.Ansi)]
public static extern bool RasEntryDlgA([MarshalAs(UnmanagedType.LPStr)] string lpszPhonebook, [MarshalAs(UnmanagedType.LPStr)] string lpszEntry, IntPtr lpInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RASDLG_RasEntryDlgA' -Namespace Win32 -PassThru
# $api::RasEntryDlgA(lpszPhonebook, lpszEntry, lpInfo)#uselib "RASDLG.dll"
#func global RasEntryDlgA "RasEntryDlgA" sptr, sptr, sptr
; RasEntryDlgA lpszPhonebook, lpszEntry, varptr(lpInfo) ; 戻り値は stat
; lpszPhonebook : LPSTR optional -> "sptr"
; lpszEntry : LPSTR optional -> "sptr"
; lpInfo : RASENTRYDLGA* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "RASDLG.dll" #cfunc global RasEntryDlgA "RasEntryDlgA" str, str, var ; res = RasEntryDlgA(lpszPhonebook, lpszEntry, lpInfo) ; lpszPhonebook : LPSTR optional -> "str" ; lpszEntry : LPSTR optional -> "str" ; lpInfo : RASENTRYDLGA* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RASDLG.dll" #cfunc global RasEntryDlgA "RasEntryDlgA" str, str, sptr ; res = RasEntryDlgA(lpszPhonebook, lpszEntry, varptr(lpInfo)) ; lpszPhonebook : LPSTR optional -> "str" ; lpszEntry : LPSTR optional -> "str" ; lpInfo : RASENTRYDLGA* in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL RasEntryDlgA(LPSTR lpszPhonebook, LPSTR lpszEntry, RASENTRYDLGA* lpInfo) #uselib "RASDLG.dll" #cfunc global RasEntryDlgA "RasEntryDlgA" str, str, var ; res = RasEntryDlgA(lpszPhonebook, lpszEntry, lpInfo) ; lpszPhonebook : LPSTR optional -> "str" ; lpszEntry : LPSTR optional -> "str" ; lpInfo : RASENTRYDLGA* in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL RasEntryDlgA(LPSTR lpszPhonebook, LPSTR lpszEntry, RASENTRYDLGA* lpInfo) #uselib "RASDLG.dll" #cfunc global RasEntryDlgA "RasEntryDlgA" str, str, intptr ; res = RasEntryDlgA(lpszPhonebook, lpszEntry, varptr(lpInfo)) ; lpszPhonebook : LPSTR optional -> "str" ; lpszEntry : LPSTR optional -> "str" ; lpInfo : RASENTRYDLGA* in/out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
rasdlg = windows.NewLazySystemDLL("RASDLG.dll")
procRasEntryDlgA = rasdlg.NewProc("RasEntryDlgA")
)
// lpszPhonebook (LPSTR optional), lpszEntry (LPSTR optional), lpInfo (RASENTRYDLGA* in/out)
r1, _, err := procRasEntryDlgA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszPhonebook))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszEntry))),
uintptr(lpInfo),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction RasEntryDlgA(
lpszPhonebook: PAnsiChar; // LPSTR optional
lpszEntry: PAnsiChar; // LPSTR optional
lpInfo: Pointer // RASENTRYDLGA* in/out
): BOOL; stdcall;
external 'RASDLG.dll' name 'RasEntryDlgA';result := DllCall("RASDLG\RasEntryDlgA"
, "AStr", lpszPhonebook ; LPSTR optional
, "AStr", lpszEntry ; LPSTR optional
, "Ptr", lpInfo ; RASENTRYDLGA* in/out
, "Int") ; return: BOOL●RasEntryDlgA(lpszPhonebook, lpszEntry, lpInfo) = DLL("RASDLG.dll", "bool RasEntryDlgA(char*, char*, void*)")
# 呼び出し: RasEntryDlgA(lpszPhonebook, lpszEntry, lpInfo)
# lpszPhonebook : LPSTR optional -> "char*"
# lpszEntry : LPSTR optional -> "char*"
# lpInfo : RASENTRYDLGA* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "rasdlg" fn RasEntryDlgA(
lpszPhonebook: [*c]const u8, // LPSTR optional
lpszEntry: [*c]const u8, // LPSTR optional
lpInfo: [*c]RASENTRYDLGA // RASENTRYDLGA* in/out
) callconv(std.os.windows.WINAPI) i32;proc RasEntryDlgA(
lpszPhonebook: cstring, # LPSTR optional
lpszEntry: cstring, # LPSTR optional
lpInfo: ptr RASENTRYDLGA # RASENTRYDLGA* in/out
): int32 {.importc: "RasEntryDlgA", stdcall, dynlib: "RASDLG.dll".}pragma(lib, "rasdlg");
extern(Windows)
int RasEntryDlgA(
const(char)* lpszPhonebook, // LPSTR optional
const(char)* lpszEntry, // LPSTR optional
RASENTRYDLGA* lpInfo // RASENTRYDLGA* in/out
);ccall((:RasEntryDlgA, "RASDLG.dll"), stdcall, Int32,
(Cstring, Cstring, Ptr{RASENTRYDLGA}),
lpszPhonebook, lpszEntry, lpInfo)
# lpszPhonebook : LPSTR optional -> Cstring
# lpszEntry : LPSTR optional -> Cstring
# lpInfo : RASENTRYDLGA* in/out -> Ptr{RASENTRYDLGA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t RasEntryDlgA(
const char* lpszPhonebook,
const char* lpszEntry,
void* lpInfo);
]]
local rasdlg = ffi.load("rasdlg")
-- rasdlg.RasEntryDlgA(lpszPhonebook, lpszEntry, lpInfo)
-- lpszPhonebook : LPSTR optional
-- lpszEntry : LPSTR optional
-- lpInfo : RASENTRYDLGA* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('RASDLG.dll');
const RasEntryDlgA = lib.func('__stdcall', 'RasEntryDlgA', 'int32_t', ['str', 'str', 'void *']);
// RasEntryDlgA(lpszPhonebook, lpszEntry, lpInfo)
// lpszPhonebook : LPSTR optional -> 'str'
// lpszEntry : LPSTR optional -> 'str'
// lpInfo : RASENTRYDLGA* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("RASDLG.dll", {
RasEntryDlgA: { parameters: ["buffer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.RasEntryDlgA(lpszPhonebook, lpszEntry, lpInfo)
// lpszPhonebook : LPSTR optional -> "buffer"
// lpszEntry : LPSTR optional -> "buffer"
// lpInfo : RASENTRYDLGA* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t RasEntryDlgA(
const char* lpszPhonebook,
const char* lpszEntry,
void* lpInfo);
C, "RASDLG.dll");
// $ffi->RasEntryDlgA(lpszPhonebook, lpszEntry, lpInfo);
// lpszPhonebook : LPSTR optional
// lpszEntry : LPSTR optional
// lpInfo : RASENTRYDLGA* in/out
// 構造体/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 Rasdlg extends StdCallLibrary {
Rasdlg INSTANCE = Native.load("rasdlg", Rasdlg.class, W32APIOptions.ASCII_OPTIONS);
boolean RasEntryDlgA(
String lpszPhonebook, // LPSTR optional
String lpszEntry, // LPSTR optional
Pointer lpInfo // RASENTRYDLGA* in/out
);
}@[Link("rasdlg")]
lib LibRASDLG
fun RasEntryDlgA = RasEntryDlgA(
lpszPhonebook : UInt8*, # LPSTR optional
lpszEntry : UInt8*, # LPSTR optional
lpInfo : RASENTRYDLGA* # RASENTRYDLGA* in/out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RasEntryDlgANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>);
typedef RasEntryDlgADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>);
final RasEntryDlgA = DynamicLibrary.open('RASDLG.dll')
.lookupFunction<RasEntryDlgANative, RasEntryDlgADart>('RasEntryDlgA');
// lpszPhonebook : LPSTR optional -> Pointer<Utf8>
// lpszEntry : LPSTR optional -> Pointer<Utf8>
// lpInfo : RASENTRYDLGA* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RasEntryDlgA(
lpszPhonebook: PAnsiChar; // LPSTR optional
lpszEntry: PAnsiChar; // LPSTR optional
lpInfo: Pointer // RASENTRYDLGA* in/out
): BOOL; stdcall;
external 'RASDLG.dll' name 'RasEntryDlgA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RasEntryDlgA"
c_RasEntryDlgA :: CString -> CString -> Ptr () -> IO CInt
-- lpszPhonebook : LPSTR optional -> CString
-- lpszEntry : LPSTR optional -> CString
-- lpInfo : RASENTRYDLGA* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let rasentrydlga =
foreign "RasEntryDlgA"
(string @-> string @-> (ptr void) @-> returning int32_t)
(* lpszPhonebook : LPSTR optional -> string *)
(* lpszEntry : LPSTR optional -> string *)
(* lpInfo : RASENTRYDLGA* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library rasdlg (t "RASDLG.dll"))
(cffi:use-foreign-library rasdlg)
(cffi:defcfun ("RasEntryDlgA" ras-entry-dlg-a :convention :stdcall) :int32
(lpsz-phonebook :string) ; LPSTR optional
(lpsz-entry :string) ; LPSTR optional
(lp-info :pointer)) ; RASENTRYDLGA* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RasEntryDlgA = Win32::API::More->new('RASDLG',
'BOOL RasEntryDlgA(LPCSTR lpszPhonebook, LPCSTR lpszEntry, LPVOID lpInfo)');
# my $ret = $RasEntryDlgA->Call($lpszPhonebook, $lpszEntry, $lpInfo);
# lpszPhonebook : LPSTR optional -> LPCSTR
# lpszEntry : LPSTR optional -> LPCSTR
# lpInfo : RASENTRYDLGA* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f RasEntryDlgW (Unicode版) — RAS電話帳エントリの作成・編集ダイアログを表示する(Unicode版)。
- f RasCreatePhonebookEntryA — ダイアログを表示し新しい電話帳エントリを作成する(ANSI版)。
- c RasCustomEntryDlgFn
- f RasEditPhonebookEntryA — ダイアログで既存の電話帳エントリを編集する(ANSI版)。