RasValidateEntryNameA 関数 (ras.h)

  • [アーティクル]

RasValidateEntryName 関数は、接続エントリ名の形式を検証します。 名前には、空白以外の英数字が少なくとも 1 文字含まれている必要があります。

構文

DWORD RasValidateEntryNameA(
  [in] LPCSTR unnamedParam1,
  [in] LPCSTR unnamedParam2
);

パラメーター

[in] unnamedParam1

電話帳 (PBK) ファイルの完全なパスとファイル名を指定する null で終わる文字列へのポインター。 このパラメーターが NULL の場合、関数は現在の既定の電話帳ファイルを使用します。

Windows Me/98/95: このパラメーターは常に NULL である必要があります。 ダイヤルアップ ネットワークでは、電話帳ファイルではなく、レジストリに電話帳エントリが格納されます。

[in] unnamedParam2

エントリ名を指定する null で終わる文字列へのポインター。

次の文字は、エントリ名では使用できません。

文字 説明
|
 垂直バー
>
 シンボルより大きい
<
 シンボルより小さい
?
疑問符
*
 アスタリスク
\
 後方スラッシュ
/
 スラッシュ
:
コロン
 

Windows 2000 以降: エントリ名はピリオド (".") で始めることはできません。

戻り値

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

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

値 説明
ERROR_ALREADY_EXISTS
 エントリ名は、指定した電話帳に既に存在します。
ERROR_CANNOT_FIND_PHONEBOOK
 指定された電話帳が存在しません。
ERROR_INVALID_NAME
 指定したエントリ名の形式が無効です。

解説

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

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

DWORD __cdecl wmain(){

    LPTSTR lpszEntry = L"EntryName\0";

    DWORD nRet = RasValidateEntryName(NULL, lpszEntry);

    switch (nRet)
    {
        case ERROR_SUCCESS:
            printf("Entry name: %s is valid but doesn't exist in the default phone book\n", lpszEntry);
            break;
        case ERROR_INVALID_NAME:
            printf("Entry name: %s is invalid\n", lpszEntry);
            break;
        case ERROR_ALREADY_EXISTS:
            printf("Entry name: %s already exists in the default phone book\n", lpszEntry);
            break;
        default:
            printf("RasValidateEntryName failed: Error = %d\n", nRet);
            break;
    }
}

注意

ras.h ヘッダーは RasValidateEntryName をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー ras.h
Library Rasapi32.lib
[DLL] Rasapi32.dll

関連項目

RasCreatePhonebookEntry

RasGetEntryProperties

リモート アクセス サービス (RAS) の概要

リモート アクセス サービス関数