RasSetEntryDialParamsA-Funktion (ras.h)

Artikel
11/20/2024

Die RasSetEntryDialParams Funktion ändert die Verbindungsinformationen, die durch den letzten erfolgreichen Aufruf des RasDial oder RasSetEntryDialParams Funktion für einen angegebenen Telefonbucheintrag gespeichert wurden.

Syntax

DWORD RasSetEntryDialParamsA(
  [in] LPCSTR           unnamedParam1,
  [in] LPRASDIALPARAMSA unnamedParam2,
  [in] BOOL             unnamedParam3
);

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.

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 die RASDIALPARAMS- Struktur, die die Verbindungsparameter angibt, die mit dem Telefonbucheintrag verknüpft werden sollen. RasSetEntryDialParams verwendet die Elemente der Struktur wie folgt.

Mitglied	Bedeutung
dwSize-	Muss die Größe von (RASDIALPARAMS) angeben, um die Version der Struktur zu identifizieren.
szEntryName	Eine mit Null beendete Zeichenfolge, die den Phone-Book-Eintrag identifiziert, für den Parameter festgelegt werden sollen.
szPhoneNumber	Wird nicht verwendet. Wird auf NULL-festgelegt.
szCallbackNumber	Eine mit Null beendete Zeichenfolge, die die Rückruftelefonnummer enthält. Wenn szCallbackNumber eine leere Zeichenfolge ( "") ist, wird die Rückrufnummer nicht geändert.
szUserName-	Eine mit Null beendete Zeichenfolge, die den Anmeldenamen des Benutzers enthält, der diesem Eintrag zugeordnet ist. Wenn szUserName eine leere Zeichenfolge ist, wird der Benutzername nicht geändert.
szPassword-	Eine mit Null beendete Zeichenfolge, die das Kennwort für den von szUserNameangegebenen Benutzer enthält. Wenn szUserName eine leere Zeichenfolge ist, wird das Kennwort nicht geändert. Wenn szPassword- eine leere Zeichenfolge ist und fRemovePassword-FALSE-ist, wird das Kennwort auf die leere Zeichenfolge festgelegt. Wenn fRemovePasswordTRUEist, wird das kennwort, das in diesem Telefonbucheintrag für den von szUserName angegebenen Benutzer gespeichert ist, unabhängig vom Inhalt der szPassword Zeichenfolge entfernt. Windows NT 4.0: Das Kennwort wird in die durch szPassword angegebene Zeichenfolge geändert, unabhängig davon, ob szUserName eine leere Zeichenfolge ist. Windows XP/2000: Wenn szPassword- das kennworthandle enthält, das von RasGetCredentials oder RasGetEntryDialParams, RasSetEntryDialParams erfolgreich zurückgegeben wird, ohne das aktuell gespeicherte Kennwort zu ändern.
szDomain	Eine mit Null beendete Zeichenfolge, die den Namen der Domäne enthält, für die sich anmelden soll. Wenn szDomain eine leere Zeichenfolge ist, wird der Domänenname nicht geändert.
dwSubEntry-	Gibt den (1-basierten) Index des anfänglichen Untervorgangs an, der beim Herstellen der Verbindung gewählt werden soll.
dwCallbackId-	Gibt einen anwendungsdefinierten Wert an, den RAS an die RasDialFunc2 Rückruffunktion übergibt.

[in] unnamedParam3

Gibt an, ob das gespeicherte Kennwort des Telefonbucheintrags für den von lprasdialparams->szUserNameangegebenen Benutzer entfernt werden soll. Wenn fRemovePasswordTRUEist, wird das Kennwort entfernt. Das Festlegen von fRemovePassword auf TRUE- entspricht dem Aktivieren des Kontrollkästchens "Kennwort speichern" im DFÜ-Netzwerk. Wenn Sie das Kennwort oder andere Eigenschaften eines Telefonbucheintrags festlegen, legen Sie fRemovePassword- auf FALSE-fest.

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	Beschreibung
ERROR_BUFFER_INVALID	Die durch lprasdialparams angegebene Adresse oder der Puffer ist ungültig.
ERROR_CANNOT_OPEN_PHONEBOOK	Das Telefonbuch ist beschädigt oder fehlende Komponenten.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	Der Telefonbucheintrag ist nicht vorhanden.

Bemerkungen

Verwenden Sie zum Erstellen eines neuen Telefonbucheintrags die RasSetEntryProperties Funktion.

Windows XP oder höher: Verwenden Sie die RasSetEntryDialParams Funktion nicht. Um die Anmeldeinformationen für einen Telefonbucheintrag festzulegen, verwenden Sie die RasSetCredentials--Funktion. Legen Sie die Nicht-Anmeldeinformationsmember von RASDIALPARAMS- fest (z. B. szCallbackNumber, dwSubEntryoder dwCallbackId) direkt in der RASDIALPARAMS Struktur, die als Parameter an die RasDial--Funktion übergeben wird.

Anmerkung

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