RasGetEntryPropertiesA-Funktion (ras.h)

Artikel
11/20/2024

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

Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die den vollständigen Pfad und Dateinamen einer PbK-Datei (Phone-Book) angibt. Wenn dieser Parameter NULL-ist, verwendet die Funktion die aktuelle Standarddatei des Telefonbuchs. Die Standardmäßige Telefonbuchdatei ist die vom Benutzer im Eigenschaftenblatt Benutzereinstellungen Eigenschaftenblatt des Dialogfelds DFÜ-Netzwerk ausgewählt.

Windows Me/98/95: Dieser Parameter sollte immer NULL-sein. DFÜ-Netzwerke speichern Telefonbucheinträge in der Registrierung und nicht in einer Telefonbuchdatei.

[in] unnamedParam2

Zeiger auf eine NULL--terminated-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 lpRasEntry und lpbDeviceInfo Parameter verwiesen wird.

[in, out] unnamedParam3

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

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

Legen Sie bei eingaben das 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 für Unicode unterstützt dwAlternateOffset in RASENTRYnicht.

[in, out] unnamedParam4

Zeiger auf eine Variable, die bei Eingabe die Größe des lpRasEntry- Puffers in Byte angibt.

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

Dieser Parameter kann NULL- werden, wenn der parameter lpRasEntryNULList.

Um die erforderliche Puffergröße zu ermitteln, rufen Sie RasGetEntryProperties auf, wobei lpRasEntry auf NULL- und *lpdwEntryInfoSize auf Null festgelegt ist. Die Funktion gibt die erforderliche Puffergröße in *lpdwEntryInfoSizezurü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 KONFIGURATION von TAPI-Geräten finden Sie in der funktion lineGetDevConfig in der TAPI Programmer's Reference 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 eingabe die Größe des durch den parameter lpbDeviceInfo angegebenen Puffers in Byte angibt.

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

Dieser Parameter kann NULL- werden, wenn der lpbDeviceInfo Parameter s NULL.

Um die erforderliche Puffergröße zu ermitteln, rufen Sie RasGetEntryProperties- auf, wobei lpbDeviceInfo auf NULL- und *lpdwDeviceInfoSize auf Null festgelegt ist. Die Funktion gibt die erforderliche Puffergröße in *lpdwDeviceInfoSizezurü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 Remotezugriffsfehlercodes 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 des lpRasEntry- ist zu klein.
ERROR_BUFFER_INVALID	Die durch 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 enthält fehlende Komponenten.

Bemerkungen

Anmerkung

Der ras.h-Header definiert RasGetEntryProperties als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	ras.h
Library	Rasapi32.lib
DLL-	Rasapi32.dll

Siehe auch

RASENTRY

RasSetEntryProperties

übersicht über Ras(Remote Access Service)

Remotezugriffsdienstfunktionen

Freigeben über