RasSetEntryPropertiesA-Funktion (ras.h)

Artikel
08/25/2023

Die RasSetEntryProperties-Funktion ändert die Verbindungsinformationen für einen Eintrag im Telefonbuch oder erstellt einen neuen Telefonbucheintrag.

Syntax

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

Parameter

[in] unnamedParam1

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

[in] unnamedParam2

Zeiger auf eine NULL-Zeichenfolge, die einen Eintragsnamen angibt.

Wenn der Eintragsname mit einem vorhandenen Eintrag übereinstimmt, ändert RasSetEntryProperties die Eigenschaften dieses Eintrags.

Wenn der Eintragsname nicht mit einem vorhandenen Eintrag übereinstimmt, erstellt RasSetEntryProperties einen neuen Telefonbucheintrag. Rufen Sie für neue Einträge die RasValidateEntryName-Funktion auf, um den Eintragsnamen vor dem Aufrufen von RasSetEntryProperties zu überprüfen.

[in] unnamedParam3

Zeiger auf die RASENTRY-Struktur , die die neuen Verbindungsdaten angibt, die dem durch den lpszEntry-Parameter angegebenen Telefonbucheintrag zugeordnet werden sollen.

Der Aufrufer muss Werte für die folgenden Member in der RASENTRY-Struktur bereitstellen.

dwSize
szLocalPhoneNumber
szDeviceName
szDeviceType
dwFramingProtocol
dwfOptions
dwType

Windows XP oder höher: dwType wird unterstützt.

Wenn für diese Member keine Werte bereitgestellt werden, schlägt RasSetEntryProperties mit ERROR_INVALID_PARAMETER fehl.

Auf die Struktur kann ein Array mit alternativen Null-Zeichenfolgen für Telefonnummern folgen. Die letzte Zeichenfolge wird durch zwei aufeinanderfolgende NULL-Zeichen beendet. Das dwAlternateOffset-Element der RASENTRY-Struktur enthält den Offset zur ersten Zeichenfolge.

[in] unnamedParam4

Gibt die Größe des Puffers in Bytes an, der durch den lpRasEntry-Parameter identifiziert wird.

[in] unnamedParam5

Zeiger auf einen Puffer, der gerätespezifische Konfigurationsinformationen angibt. Dies sind undurchsichtige TAPI-Gerätekonfigurationsinformationen. Weitere Informationen zur TAPI-Gerätekonfiguration finden Sie unter lineGetDevConfig in TapI (Telephony Application Programming Interfaces) im Platform SDK.

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

[in] unnamedParam6

Gibt die Größe des puffers lpbDeviceInfo in Bytes an.

Windows XP: Dieser Parameter wird nicht verwendet. Die aufrufende Funktion sollte diesen Parameter auf 0 festlegen.

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_ACCESS_DENIED	Der Benutzer verfügt nicht über die richtigen Berechtigungen. Nur ein Administrator kann diese Aufgabe ausführen.
ERROR_BUFFER_INVALID	Die von lpRasEntry angegebene Adresse oder der Puffer ist ungültig.
ERROR_CANNOT_OPEN_PHONEBOOK	Das Telefonbuch ist beschädigt oder es fehlen Komponenten.
ERROR_INVALID_PARAMETER	Die RASENTRY-Struktur , auf die der lpRasEntry-Parameter verweist, enthält keine ausreichenden Informationen, oder der angegebene Eintrag ist nicht im Telefonbuch vorhanden. Welche Informationen erforderlich sind, finden Sie in der Beschreibung für lpRasEntry .

Hinweise

Wenn die aufrufende Anwendung beim Festlegen von Eigenschaften für eine Verbindung mit allen Benutzern einen wert ungleich NULL für den Telefonbuchparameter lpszPhonebook angibt, muss sich die Telefonbuchdatei im Telefonbuchverzeichnis unterhalb des Anwendungsdatenpfads für alle Benutzer befinden. Um den richtigen Speicherort für die Telefonbuchdatei zu erhalten, rufen Sie zuerst SHGetFolderPath mit dem CSIDL-WertCSIDL_COMMON_APPDATA auf. SHGetFolderPath gibt den Anwendungsdatenpfad für alle Benutzer zurück. Fügen Sie die folgende Zeichenfolge an diesen Pfad an:

Microsoft\Network\Connections\Pbk

Der kombinierte Pfad ist der richtige Speicherort für die Telefonbuchdatei.

Hinweis Das Angeben eines Nicht-NULL-Werts für den lpszPhonebook-Parameter wird in Versionen von Windows ab Windows XP möglicherweise nicht unterstützt.

Hinweis

Der ras.h-Header definiert RasSetEntryProperties 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 nicht codierungsneutralem Code 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