Funzione RasGetSubEntryPropertiesA (ras.h)

Articolo
11/20/2024

La funzione RasGetSubEntryProperties recupera informazioni su una sottosezione per una voce di rubrica telefonica specificata.

Sintassi

DWORD RasGetSubEntryPropertiesA(
  [in]      LPCSTR         unnamedParam1,
  [in]      LPCSTR         unnamedParam2,
  [in]      DWORD          unnamedParam3,
  [in, out] LPRASSUBENTRYA unnamedParam4,
  [in, out] LPDWORD        unnamedParam5,
  [in]      LPBYTE         unnamedParam6,
  [in]      LPDWORD        unnamedParam7
);

Parametri

[in] unnamedParam1

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

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

[in] unnamedParam2

Puntatore a un nullstringa con terminazione che specifica il nome di una voce esistente nella rubrica telefonica.

[in] unnamedParam3

Specifica l'indice in base uno della sottoentità.

[in, out] unnamedParam4

Puntatore alla struttura RASSUBENTRY seguita da byte aggiuntivi per l'elenco di numeri di telefono alternativi, se presente.

In caso di output, la struttura riceve informazioni sulla sottoentreità specificata.

In caso di input, il membro dwSize specifica le dimensioni della struttura. La dimensione identifica la versione della struttura. Ottenere questa dimensione usando sizeof(RASSUBENTRY).

Questo parametro può essere NULL.

[in, out] unnamedParam5

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

Nell'output, la variabile riceve il numero di byte restituiti o il numero di byte necessari se il buffer è troppo piccolo.

Questo parametro può essere NULL se lpRasSubEntry è NULL.

[in] unnamedParam6

Puntatore a un blocco di configurazione del dispositivo TAPI. Questo parametro è attualmente inutilizzato. Il chiamante deve passare NULL per questo parametro. Per altre informazioni sui blocchi di configurazione del dispositivo TAPI, vedere la funzione lineGetDevConfig.

[in] unnamedParam7

Puntatore a un DWORD che specifica le dimensioni del blocco di configurazione del dispositivo TAPI. Questo parametro è attualmente inutilizzato. Il chiamante deve passare NULL per questo parametro.

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

Valore	Significato
ERROR_INVALID_PARAMETER	La funzione è stata chiamata con un parametro non valido.
ERROR_BUFFER_INVALID	L'indirizzo o il buffer specificato da lpRasSubEntry non è valido.
ERROR_BUFFER_TOO_SMALL	Il buffer lpRasSubEntry è troppo piccolo. La variabile lpdwcb riceve le dimensioni del buffer necessarie.
ERROR_CANNOT_OPEN_PHONEBOOK	La rubrica telefonica è danneggiata o è mancante.
ERROR_CANNOT_FIND_PHONEBOOK_ENTRY	La voce della rubrica telefonica non esiste.

Osservazioni

Una voce della rubrica telefonica RAS può avere zero o più sottoinsieme, ognuna costituita minimamente da un dispositivo e da un numero di telefono. Una voce della rubrica telefonica con più voci secondarie può essere configurata per comporre la prima voce disponibile o tutte le sottoinsieme quando la voce è chiamata.

Utilizzare la funzione RasGetEntryProperties per recuperare una struttura RASENTRY contenente informazioni sulle voci secondarie di una voce di rubrica telefonica. Il membro dwSubEntries indica il numero di voci secondarie e il membro dwDialMode indica la configurazione di composizione.

Nota

L'intestazione ras.h definisce RasGetSubEntryProperties 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 indipendente dalla codifica con il codice non indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere convenzioni di per i prototipi di funzioni.

Fabbisogno

Requisito	Valore
client minimo supportato	Windows 2000 Professional [solo app desktop]
server minimo supportato	Windows 2000 Server [solo app desktop]
piattaforma di destinazione	Finestre
intestazione	ras.h
libreria	Rasapi32.lib
dll	Rasapi32.dll