RasGetSubEntryPropertiesA-Funktion (ras.h)

Artikel
11/20/2024

Die RasGetSubEntryProperties Funktion ruft Informationen zu einem Untereintrag für ein angegebenes Telefonbuch ab.

Syntax

DWORD RasGetSubEntryPropertiesA(
  [in]      LPCSTR         unnamedParam1,
  [in]      LPCSTR         unnamedParam2,
  [in]      DWORD          unnamedParam3,
  [in, out] LPRASSUBENTRYA unnamedParam4,
  [in, out] LPDWORD        unnamedParam5,
  [in]      LPBYTE         unnamedParam6,
  [in]      LPDWORD        unnamedParam7
);

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

Zeigen Sie auf eine NULL--terminated-Zeichenfolge, die den Namen eines vorhandenen Eintrags im Telefonbuch angibt.

[in] unnamedParam3

Gibt den 1-basierten Index des Untervorgangs an.

[in, out] unnamedParam4

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

Bei der Ausgabe empfängt die Struktur Informationen zum angegebenen Untervorgang.

Bei Eingaben gibt das dwSize Member die Größe der Struktur an. Die Größe gibt die Version der Struktur an. Rufen Sie diese Größe mit sizeof(RASSUBENTRY) ab.

Dieser Parameter kann NULL-sein.

[in, out] unnamedParam5

Zeigen Sie auf eine Variable, die bei Eingaben die Größe des lpRasSubEntry- Puffers in Byte angibt.

Bei der Ausgabe empfängt die Variable die Anzahl der zurückgegebenen Bytes oder die Anzahl der erforderlichen Bytes, wenn der Puffer zu klein ist.

Dieser Parameter kann NULL- werden, wenn lpRasSubEntry-NULL-ist.

[in] unnamedParam6

Zeiger auf einen TAPI-Gerätekonfigurationsblock. Dieser Parameter wird derzeit nicht verwendet. Der Aufrufer sollte NULL- für diesen Parameter übergeben. Weitere Informationen zu TAPI-Gerätekonfigurationsblöcken finden Sie in der Funktion lineGetDevConfig.

[in] unnamedParam7

Zeiger auf einen DWORD-, der die Größe des TAPI-Gerätekonfigurationsblocks angibt. Dieser Parameter wird derzeit nicht verwendet. Der Aufrufer sollte NULL- für diesen Parameter übergeben.

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_BUFFER_INVALID	Die durch lpRasSubEntry angegebene Adresse oder der Puffer ist ungültig.
ERROR_BUFFER_TOO_SMALL	Der lpRasSubEntry Puffer ist zu klein. Die lpdwcb- Variable erhält die erforderliche Puffergröße.
ERROR_CANNOT_OPEN_PHONEBOOK	Das Telefonbuch ist beschädigt oder fehlen Komponenten.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Der Telefonbucheintrag ist nicht vorhanden.

Bemerkungen

Ein RAS-Telefonbucheintrag kann null oder mehr Untereinträge aufweisen, die jeweils minimal aus einem Gerät und einer Telefonnummer bestehen. Ein Telefonbucheintrag mit mehreren Untereinträgen kann so konfiguriert werden, dass er die erste verfügbare oder alle Untereinträge wählt, wenn der Eintrag gewählt wird.

Verwenden Sie die RasGetEntryProperties--Funktion, um eine RASENTRY- Struktur abzurufen, die Informationen über die Untereinträge eines Telefonbucheintrags enthält. Der dwSubEntries Member gibt die Anzahl der Unterriesen und das dwDialMode Member die Wählkonfiguration an.

Anmerkung

Der ras.h-Header definiert RasGetSubEntryProperties 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