Funzione RasGetEntryPropertiesA (ras.h)

  • Articolo

La funzione RasGetEntryProperties recupera le proprietà di una voce della rubrica telefonica.

Sintassi

DWORD RasGetEntryPropertiesA(
  [in]      LPCSTR      unnamedParam1,
  [in]      LPCSTR      unnamedParam2,
  [in, out] LPRASENTRYA unnamedParam3,
  [in, out] LPDWORD     unnamedParam4,
  [out]     LPBYTE      unnamedParam5,
  [in, out] LPDWORD     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 .

Windows Me/98/95: Questo parametro deve sempre essere NULL. La rete con accesso esterno archivia le voci della rubrica telefonica nel Registro di sistema anziché in un file di rubrica telefonica.

[in] unnamedParam2

Puntatore a una stringa con terminazione null che specifica un nome di voce esistente. Se viene specificata una stringa vuota, la funzione restituisce valori predefiniti nei buffer a cui puntano i parametri lpRasEntry e lpbDeviceInfo .

[in, out] unnamedParam3

Puntatore a una struttura RASENTRY seguita da byte aggiuntivi per l'elenco di numeri di telefono alternativi, se presente.

In output, la struttura riceve i dati di connessione associati alla voce della rubrica telefonica specificata dal parametro lpszEntry .

In input impostare il membro dwSize della struttura su sizeof(RASENTRY) per identificare la versione della struttura.

Questo parametro può essere NULL.

Windows Me/98 e Windows 95 OSR2: Il livello Microsoft per Unicode non supporta dwAlternateOffset in RASENTRY.

[in, out] unnamedParam4

Puntatore a una variabile che, in input, specifica le dimensioni, in byte, del buffer lpRasEntry .

Nell'output, questa variabile riceve il numero di byte necessari.

Questo parametro può essere NULL se il parametro lpRasEntry è NULL.

Per determinare le dimensioni del buffer necessarie, chiamare RasGetEntryProperties con lpRasEntry impostato su NULL e *lpdwEntryInfoSize impostato su zero. La funzione restituisce le dimensioni del buffer necessarie in *lpdwEntryInfoSize.

[out] unnamedParam5

Questo parametro non viene più usato. La funzione chiamante deve impostare questo parametro su NULL.

Windows Me/98/95: Puntatore a un buffer che riceve informazioni di configurazione specifiche del dispositivo. Non modificare direttamente queste informazioni sul dispositivo TAPI opaco. Per altre informazioni sulla configurazione del dispositivo TAPI, vedere la funzione lineGetDevConfig nel riferimento del programmatore TAPI in Platform SDK.

Questo parametro può essere NULL.

[in, out] unnamedParam6

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

Windows Me/98/95: Puntatore a una variabile che, in input, specifica le dimensioni, in byte, del buffer specificato dal parametro lpbDeviceInfo .

Nell'output, questa variabile riceve il numero di byte necessari.

Questo parametro può essere NULL se il parametro lpbDeviceInfo s NULL.

Per determinare le dimensioni del buffer necessarie, chiamare RasGetEntryProperties con lpbDeviceInfo impostato su NULL e *lpdwDeviceInfoSize impostato su zero. La funzione restituisce le dimensioni del buffer necessarie in *lpdwDeviceInfoSize.

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 Routing e codici di errore di accesso remoto o Winerror.h.

Valore Significato
ERROR_INVALID_PARAMETER
 La funzione è stata chiamata con un parametro non valido.
ERROR_INVALID_SIZE
 Il valore del membro dwSize dell'oggetto lpRasEntry è troppo piccolo.
ERROR_BUFFER_INVALID
 L'indirizzo o il buffer specificato da lpRasEntry non è valido.
ERROR_BUFFER_TOO_SMALL
 Le dimensioni del buffer indicate in lpdwEntryInfoSize sono troppo piccole.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY
 La voce della rubrica telefonica non esiste o il file della rubrica telefonica è danneggiato e/o ha componenti mancanti.

Commenti

Nota

L'intestazione ras.h definisce RasGetEntryProperties come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del 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

Requisito Valore
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

Vedi anche

RASENTRY

Rassetentryproperties

Panoramica del servizio di accesso remoto (RAS)

Funzioni del Servizio di accesso remoto