ホーム › NetworkManagement.Rras › RasSetCredentialsA

RasSetCredentialsA

関数

RASエントリの認証資格情報を設定する(ANSI版)。

DLLRASAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD RasSetCredentialsA(
    LPCSTR param0,   // optional
    LPCSTR param1,
    RASCREDENTIALSA* param2,
    BOOL param3
);

パラメーター

名前	型	方向	説明
param0	LPCSTR	inoptional	電話帳ファイルのフルパス文字列。NULL指定で既定の電話帳を使用する。
param1	LPCSTR	in	資格情報を設定する対象エントリ名の文字列。
param2	RASCREDENTIALSA*	in	設定する資格情報を格納したRASCREDENTIALSA構造体へのポインタ。dwMaskで設定項目を指定する。
param3	BOOL	in	TRUEで指定資格情報を消去、FALSEで設定する真偽値。

戻り値の型: DWORD

公式ドキュメント

指定した RAS 電話帳エントリに関連付けられているユーザー資格情報を設定します。(ANSI)

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのエラーコード、または Routing and Remote Access Error Codes もしくは WinError.h に定義されている値です。

値	意味
ERROR_CANNOT_OPEN_PHONEBOOK	指定された電話帳が見つかりません。
ERROR_INVALID_PARAMETER	lpCredentials パラメーターが NULL であるか、指定されたエントリが電話帳に存在しません。
ERROR_ACCESS_DENIED	次のいずれかの状況が発生しました。呼び出し元のアプリケーションが、ユーザーごとの接続に対して既定の資格情報を設定しようとしました。既定の資格情報は、すべてのユーザー用の接続に対してのみ設定できます。すべてのユーザー用の接続 (コネクトイド) の場合に、事前共有キーまたはすべてのユーザーの資格情報を設定するための適切な特権をユーザーが持っていません。これらの操作を実行できるのは管理者のみです。

解説(Remarks)

RasSetCredentials 関数は、指定した RAS 電話帳エントリに関連付けられているユーザー資格情報を設定します。電話帳エントリに格納される資格情報は、その電話帳エントリを使用して最後に接続に成功したユーザーの資格情報、またはその電話帳エントリに対して RasSetCredentials 関数や RasSetEntryDialParams 関数の呼び出しで後から指定された資格情報です。

RasSetCredentials 関数は、電話帳エントリに資格情報を安全に格納するための推奨される方法です。RasSetCredentials は RasSetEntryDialParams 関数に代わるものであり、後者は今後の Windows オペレーティングシステムのリリースではサポートされない可能性があります。

パスワードハンドルは "****************" (アスタリスク 16 個) です。RasGetCredentials を呼び出してパスワードフィールドに 16 個の * が返された場合、パスワードは格納されていますが、セキュリティ上の理由からプレーンテキストでは返されません。RASCREDENTIALS 構造体の szPassword メンバーに、RasGetCredentials または RasGetEntryDialParams が返したパスワードハンドル (16 個の *) が含まれている場合、次の RasSetCredentials の呼び出しでは、保存されているパスワードは変更されません。

すべてのユーザー用の接続に既定の資格情報を設定するには、lpCredentials パラメーターが指す RASCREDENTIALS 構造体の dwMask メンバーに RASCM_DefaultCreds フラグを設定します。ユーザーごとの接続に既定の資格情報を設定しようとすると、RasSetCredentials は ERROR_ACCESS_DENIED を返します。

すべてのユーザー用の接続に資格情報を設定する場合、呼び出し元のアプリケーションが電話帳のパラメーター lpszPhonebook に NULL 以外の値を指定するときは、その電話帳ファイルは、すべてのユーザー用のアプリケーションデータパスの下にある電話帳ディレクトリに配置されている必要があります。電話帳ファイルの正しい場所を取得するには、まず CSIDL 値として CSIDL_COMMON_APPDATA を指定して SHGetFolderPath を呼び出します。SHGetFolderPath は、すべてのユーザー用のアプリケーションデータパスを返します。このパスに次の文字列を追加してください。

Microsoft\Network\Connections\Pbk

連結したパスが、電話帳ファイルの正しい場所です。

メモ lpszPhonebook パラメーターに NULL 以外の値を指定する方法は、今後のバージョンの Windows オペレーティングシステムではサポートされない可能性があります。

事前共有キーを設定するには、RASCREDENTIALS の dwMask フィールドに RASCM_PreSharedKey フラグを使用します。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 RasSetCredentialsA(
    LPCSTR param0,   // optional
    LPCSTR param1,
    RASCREDENTIALSA* param2,
    BOOL param3
);

[DllImport("RASAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint RasSetCredentialsA(
    [MarshalAs(UnmanagedType.LPStr)] string param0,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string param1,   // LPCSTR
    IntPtr param2,   // RASCREDENTIALSA*
    bool param3   // BOOL
);

<DllImport("RASAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RasSetCredentialsA(
    <MarshalAs(UnmanagedType.LPStr)> param0 As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> param1 As String,   ' LPCSTR
    param2 As IntPtr,   ' RASCREDENTIALSA*
    param3 As Boolean   ' BOOL
) As UInteger
End Function

' param0 : LPCSTR optional
' param1 : LPCSTR
' param2 : RASCREDENTIALSA*
' param3 : BOOL
Declare PtrSafe Function RasSetCredentialsA Lib "rasapi32" ( _
    ByVal param0 As String, _
    ByVal param1 As String, _
    ByVal param2 As LongPtr, _
    ByVal param3 As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RasSetCredentialsA = ctypes.windll.rasapi32.RasSetCredentialsA
RasSetCredentialsA.restype = wintypes.DWORD
RasSetCredentialsA.argtypes = [
    wintypes.LPCSTR,  # param0 : LPCSTR optional
    wintypes.LPCSTR,  # param1 : LPCSTR
    ctypes.c_void_p,  # param2 : RASCREDENTIALSA*
    wintypes.BOOL,  # param3 : BOOL
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RASAPI32.dll')
RasSetCredentialsA = Fiddle::Function.new(
  lib['RasSetCredentialsA'],
  [
    Fiddle::TYPE_VOIDP,  # param0 : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # param1 : LPCSTR
    Fiddle::TYPE_VOIDP,  # param2 : RASCREDENTIALSA*
    Fiddle::TYPE_INT,  # param3 : BOOL
  ],
  -Fiddle::TYPE_INT)

#[link(name = "rasapi32")]
extern "system" {
    fn RasSetCredentialsA(
        param0: *const u8,  // LPCSTR optional
        param1: *const u8,  // LPCSTR
        param2: *mut RASCREDENTIALSA,  // RASCREDENTIALSA*
        param3: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RASAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint RasSetCredentialsA([MarshalAs(UnmanagedType.LPStr)] string param0, [MarshalAs(UnmanagedType.LPStr)] string param1, IntPtr param2, bool param3);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RASAPI32_RasSetCredentialsA' -Namespace Win32 -PassThru
# $api::RasSetCredentialsA(param0, param1, param2, param3)

#uselib "RASAPI32.dll"
#func global RasSetCredentialsA "RasSetCredentialsA" sptr, sptr, sptr, sptr
; RasSetCredentialsA param0, param1, varptr(param2), param3   ; 戻り値は stat
; param0 : LPCSTR optional -> "sptr"
; param1 : LPCSTR -> "sptr"
; param2 : RASCREDENTIALSA* -> "sptr"
; param3 : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RASAPI32.dll"
#cfunc global RasSetCredentialsA "RasSetCredentialsA" str, str, var, int
; res = RasSetCredentialsA(param0, param1, param2, param3)
; param0 : LPCSTR optional -> "str"
; param1 : LPCSTR -> "str"
; param2 : RASCREDENTIALSA* -> "var"
; param3 : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RASAPI32.dll"
#cfunc global RasSetCredentialsA "RasSetCredentialsA" str, str, sptr, int
; res = RasSetCredentialsA(param0, param1, varptr(param2), param3)
; param0 : LPCSTR optional -> "str"
; param1 : LPCSTR -> "str"
; param2 : RASCREDENTIALSA* -> "sptr"
; param3 : BOOL -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。