RasSetEntryPropertiesA-Funktion (ras.h)

Artikel
11/20/2024

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

Zeigen Sie auf eine mit Null beendete 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.

[in] unnamedParam2

Zeiger auf eine mit Null beendete Zeichenfolge, die einen Eintragsnamen angibt.

Wenn der Eintragsname einem vorhandenen Eintrag entspricht, ändert RasSetEntryProperties die Eigenschaften dieses Eintrags.

Wenn der Eintragsname keinem vorhandenen Eintrag entspricht, erstellt RasSetEntryProperties einen neuen Telefonbucheintrag. Rufen Sie für neue Einträge die RasValidateEntryName-Funktion auf, um den Eintragsnamen zu überprüfen, bevor RasSetEntryPropertiesaufgerufen wird.

[in] unnamedParam3

Zeigen Sie 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 werte für diese Member nicht angegeben werden, schlägt RasSetEntryProperties mit ERROR_INVALID_PARAMETERfehl.

Auf die Struktur kann ein Array mit null-beendeten alternativen Telefonnummernzeichenfolgen folgen. Die letzte Zeichenfolge wird durch zwei aufeinander folgende Nullzeichen 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

Zeigen Sie auf einen Puffer, der gerätespezifische Konfigurationsinformationen angibt. Dies ist undurchsichtige TAPI-Gerätekonfigurationsinformationen. Weitere Informationen zur TAPI-Gerätekonfiguration finden Sie in der lineGetDevConfig Funktion in TapI- 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 lpbDeviceInfo- Puffers in Bytes an.

Windows XP: Dieser Parameter wird nicht verwendet. Die aufrufende Funktion sollte diesen Parameter auf Null 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 Remotezugriffsfehlercodes 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 durch lpRasEntry- angegebene Adresse oder der puffer ist ungültig.
ERROR_CANNOT_OPEN_PHONEBOOK	Das Telefonbuch ist beschädigt oder fehlende Komponenten.
ERROR_INVALID_PARAMETER	Die RASENTRY Struktur, auf die der lpRasEntry Parameter verweist, enthält keine ausreichenden Informationen, oder der angegebene Eintrag ist im Telefonbuch nicht vorhanden. Lesen Sie die Beschreibung für lpRasEntry-, um zu sehen, welche Informationen erforderlich sind.

Bemerkungen

Wenn die aufrufendeAnwendung eigenschaften für eine Verbindung mit allen Benutzern festlegt, muss sich die Telefonbuchdatei unter dem Datenpfad für alle Benutzer im Verzeichnis des Telefonbuchs NULL Wert für den Phone-Book-Parameter befinden. Um den richtigen Speicherort für die Telefonbuchdatei abzurufen, rufen Sie zuerst SHGetFolderPath- mit einem CSIDL- Wert von CSIDL_COMMON_APPDATAauf. SHGetFolderPath- gibt den Datenpfad 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 Angeben eines Werts ohneNULL für den parameter lpszPhonebook möglicherweise nicht in Versionen von Windows später als Windows XP unterstützt werden.

Anmerkung

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