Funzione RasSetEntryPropertiesA (ras.h)

Articolo
08/25/2023

La funzione RasSetEntryProperties modifica le informazioni di connessione per una voce nella rubrica telefonica o crea una nuova voce della rubrica telefonica.

Sintassi

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

Parametri

[in] unnamedParam1

Puntatore a una stringa con terminazione null che specifica il percorso completo e il nome file di un file PBK (Phone Book). Se questo parametro è NULL, la funzione usa il file di rubrica telefonico predefinito corrente. Il file di rubrica telefonico predefinito è quello selezionato dall'utente nella finestra di proprietà Preferenze utente della finestra di dialogo Rete remota .

[in] unnamedParam2

Puntatore a una stringa con terminazione null che specifica un nome di voce.

Se il nome della voce corrisponde a una voce esistente, RasSetEntryProperties modifica le proprietà di tale voce.

Se il nome della voce non corrisponde a una voce esistente, RasSetEntryProperties crea una nuova voce della rubrica telefonica. Per le nuove voci, chiamare la funzione RasValidateEntryName per convalidare il nome della voce prima di chiamare RasSetEntryProperties.

[in] unnamedParam3

Puntatore alla struttura RASENTRY che specifica i nuovi dati di connessione da associare alla voce della rubrica telefonica indicata dal parametro lpszEntry .

Il chiamante deve fornire valori per i membri seguenti nella struttura RASENTRY .

dwSize
szLocalPhoneNumber
szDeviceName
szDeviceType
dwFramingProtocol
dwfOptions
dwType

Windows XP o versione successiva: dwType è supportato.

Se i valori non vengono forniti per questi membri, RasSetEntryProperties non riesce con ERROR_INVALID_PARAMETER.

La struttura potrebbe essere seguita da una matrice di stringhe di numeri di telefono alternativi con terminazione null. L'ultima stringa viene terminata da due caratteri Null consecutivi. Il membro dwAlternateOffset della struttura RASENTRY contiene l'offset alla prima stringa.

[in] unnamedParam4

Specifica le dimensioni, in byte, del buffer identificato dal parametro lpRasEntry .

[in] unnamedParam5

Puntatore a un buffer che specifica le informazioni di configurazione specifiche del dispositivo. Si tratta di informazioni di configurazione del dispositivo TAPI opache. Per altre informazioni sulla configurazione del dispositivo TAPI, vedere la funzione lineGetDevConfig in Interfacce di programmazione dell'applicazione di telefonia (TAPI) in Platform SDK.

Windows XP: Questo parametro è inutilizzato. La funzione chiamante deve impostare questo parametro su NULL.

[in] unnamedParam6

Specifica le dimensioni, in byte, del buffer lpbDeviceInfo .

Windows XP: Questo parametro è inutilizzato. La funzione chiamante deve impostare questo parametro su zero.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è ERROR_SUCCESS.

Se la funzione ha esito negativo, il valore restituito è uno dei codici di errore seguenti o un valore da Codici di errore routing e accesso remoto o WinError.h.

Valore	Significato
ERROR_ACCESS_DENIED	L'utente non dispone dei privilegi corretti. Solo un amministratore può completare questa attività.
ERROR_BUFFER_INVALID	L'indirizzo o il buffer specificato da lpRasEntry non è valido.
ERROR_CANNOT_OPEN_PHONEBOOK	Il telefono è danneggiato o mancante componenti.
ERROR_INVALID_PARAMETER	La struttura RASENTRY puntata dal parametro lpRasEntry non contiene informazioni adeguate o la voce specificata non esiste nella rubrica telefonica. Per visualizzare le informazioni necessarie, vedere la descrizione per lpRasEntry .

Commenti

Quando si impostano le proprietà per una connessione a tutti gli utenti, se l'applicazione chiamante specifica un valore non NULL per il parametro phone-book, lpszPhonebook, il file della rubrica telefonica deve trovarsi nella directory della rubrica telefonica sotto il percorso dei dati dell'applicazione all-users. Per ottenere la posizione corretta per il file della rubrica telefonica, chiamare prima SHGetFolderPath con un valore CSIDL di CSIDL_COMMON_APPDATA. SHGetFolderPath restituisce il percorso dati dell'applicazione all-users. Aggiungere la stringa seguente a questo percorso:

Microsoft\Network\Connections\Pbk

Il percorso combinato è il percorso corretto per il file della rubrica telefonica.

Nota La specifica di un valore non NULL per il parametro lpszPhonebook potrebbe non essere supportata nelle versioni di Windows successive a Windows XP.

Nota

L'intestazione ras.h definisce RasSetEntryProperties come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante preprocessore UNICODE. La combinazione dell'utilizzo dell'alias di codifica neutrale con il codice che non è neutrale dalla codifica può causare errori di corrispondenza che causano errori di compilazione o runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzione.

Requisiti


Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	ras.h
Libreria	Rasapi32.lib
DLL	Rasapi32.dll