RasGetEntryPropertiesA-Funktion (ras.h)

Die RasGetEntryProperties-Funktion ruft die Eigenschaften eines Telefonbucheintrags ab.

Syntax

DWORD RasGetEntryPropertiesA(
  [in]      LPCSTR      unnamedParam1,
  [in]      LPCSTR      unnamedParam2,
  [in, out] LPRASENTRYA unnamedParam3,
  [in, out] LPDWORD     unnamedParam4,
  [out]     LPBYTE      unnamedParam5,
  [in, out] LPDWORD     unnamedParam6
);

Parameter

[in] unnamedParam1

Zeiger auf eine NULL-endende Zeichenfolge, die den vollständigen Pfad und Dateinamen einer Telefonbuchdatei (PBK) angibt. Wenn dieser Parameter NULL ist, verwendet die Funktion die aktuelle Standardtelefonbuchdatei. Die Standardmäßige Telefonbuchdatei wird vom Benutzer im Eigenschaftenblatt Benutzereinstellungen des DialogfeldsDFÜ-Netzwerk ausgewählt.

Windows Me/98/95: Dieser Parameter sollte immer NULL sein. Einwahlnetzwerk speichert Telefonbucheinträge in der Registrierung und nicht in einer Telefonbuchdatei.

[in] unnamedParam2

Zeiger auf eine NULL-endende Zeichenfolge, die einen vorhandenen Eintragsnamen angibt. Wenn eine leere Zeichenfolge angegeben wird, gibt die Funktion Standardwerte in den Puffern zurück, auf die durch die Parameter lpRasEntry und lpbDeviceInfo verwiesen wird.

[in, out] unnamedParam3

Zeiger auf eine RASENTRY-Struktur , gefolgt von zusätzlichen Bytes für die alternative Telefonnummernliste, sofern vorhanden.

Bei der Ausgabe empfängt die Struktur die Verbindungsdaten, die dem durch den lpszEntry-Parameter angegebenen Telefonbucheintrag zugeordnet sind.

Legen Sie bei der Eingabe den dwSize-Member der Struktur auf sizeof(RASENTRY) fest, um die Version der Struktur zu identifizieren.

Dieser Parameter kann NULL sein.

Windows Me/98 und Windows 95 OSR2: Microsoft Layer for Unicode unterstützt dwAlternateOffset in RASENTRY nicht.

[in, out] unnamedParam4

Zeiger auf eine Variable, die bei der Eingabe die Größe des puffers lpRasEntry in Bytes angibt.

Bei der Ausgabe empfängt diese Variable die erforderliche Anzahl von Bytes.

Dieser Parameter kann NULL sein, wenn der lpRasEntry-ParameterNULL ist.

Um die erforderliche Puffergröße zu bestimmen, rufen Sie RasGetEntryProperties auf, wobei lpRasEntry auf NULL und *lpdwEntryInfoSize auf Null festgelegt ist. Die Funktion gibt die erforderliche Puffergröße in *lpdwEntryInfoSize zurück.

[out] unnamedParam5

Dieser Parameter wird nicht mehr verwendet. Die aufrufende Funktion sollte diesen Parameter auf NULL festlegen.

Windows Me/98/95: Zeiger auf einen Puffer, der gerätespezifische Konfigurationsinformationen empfängt. Bearbeiten Sie diese undurchsichtigen TAPI-Geräteinformationen nicht direkt. Weitere Informationen zur TAPI-Gerätekonfiguration finden Sie unter der lineGetDevConfig-Funktion in der TAPI-Programmiererreferenz im Platform SDK.

Dieser Parameter kann NULL sein.

[in, out] unnamedParam6

Dieser Parameter wird nicht verwendet. Die aufrufende Funktion sollte diesen Parameter auf NULL festlegen.

Windows Me/98/95: Zeiger auf eine Variable, die bei der Eingabe die Größe des durch den lpbDeviceInfo-Parameter angegebenen Puffers in Bytes angibt.

Bei der Ausgabe empfängt diese Variable die erforderliche Anzahl von Bytes.

Dieser Parameter kann NULL sein, wenn der lpbDeviceInfo-Parameternull ist.

Um die erforderliche Puffergröße zu bestimmen, rufen Sie RasGetEntryProperties auf, wobei lpbDeviceInfo auf NULL und *lpdwDeviceInfoSize auf null festgelegt ist. Die Funktion gibt die erforderliche Puffergröße in *lpdwDeviceInfoSize zurück.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert ERROR_SUCCESS.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes oder ein Wert aus Routing- und RAS-Fehlercodes oder Winerror.h.

Wert	Bedeutung
ERROR_INVALID_PARAMETER	Die Funktion wurde mit einem ungültigen Parameter aufgerufen.
ERROR_INVALID_SIZE	Der Wert des dwSize-Elements von lpRasEntry ist zu klein.
ERROR_BUFFER_INVALID	Die von lpRasEntry angegebene Adresse oder der puffer ist ungültig.
ERROR_BUFFER_TOO_SMALL	Die in lpdwEntryInfoSize angegebene Puffergröße ist zu klein.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Der Telefonbucheintrag ist nicht vorhanden, oder die Telefonbuchdatei ist beschädigt und/oder verfügt über fehlende Komponenten.

Hinweise

Hinweis

Der ras.h-Header definiert RasGetEntryProperties als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	ras.h
Bibliothek	Rasapi32.lib
DLL	Rasapi32.dll

Weitere Informationen

RASENTRY

RasSetEntryProperties

Übersicht über ras (Remote Access Service, RAS)

Funktionen des RAS-Diensts