Funzione NetUseEnum (lmuse.h)

Articolo
08/24/2023

La funzione NetUseEnum elenca tutte le connessioni correnti tra il computer locale e le risorse nei server remoti.

È anche possibile usare le funzioni WNetOpenEnum e WNetEnumResource per enumerare le risorse o le connessioni di rete.

Sintassi

NET_API_STATUS NET_API_FUNCTION NetUseEnum(
  [in]      LMSTR   UncServerName,
  [in]      DWORD   LevelFlags,
  [out]     LPBYTE  *BufPtr,
  [in]      DWORD   PreferedMaximumSize,
  [out]     LPDWORD EntriesRead,
  [out]     LPDWORD TotalEntries,
  [in, out] LPDWORD ResumeHandle
);

Parametri

[in] UncServerName

Nome UNC del computer in cui eseguire questa funzione. Se questo parametro è NULL, viene usato il computer locale. Se il parametro UncServerName specificato è un computer remoto, il computer remoto deve supportare le chiamate RPC remote usando il meccanismo legacy remote Access Protocol.

Questa stringa è Unicode se sono definite _WIN32_WINNT o FORCE_UNICODE .

[in] LevelFlags

Livello informativo dei dati richiesti. Questo parametro può avere uno dei valori seguenti.

Valore	Significato
0	Specifica un nome di dispositivo locale e il nome della condivisione di una risorsa remota. Il parametro BufPtr punta a una matrice di strutture USE_INFO_0 .
1	Specifica informazioni sulla connessione tra un dispositivo locale e una risorsa condivisa, inclusi lo stato e il tipo di connessione. Il parametro BufPtr punta a una matrice di strutture USE_INFO_1 .
2	Specifica informazioni sulla connessione tra un dispositivo locale e una risorsa condivisa. Le informazioni includono lo stato della connessione, il tipo di connessione, il nome utente e il nome di dominio. Il parametro BufPtr punta a una matrice di strutture USE_INFO_2 .

[out] BufPtr

Puntatore al buffer che riceve le strutture di informazioni. Il formato di questi dati dipende dal valore del parametro Level . Questo buffer viene allocato dal sistema e deve essere liberato usando la funzione NetApiBufferFree quando le informazioni non sono più necessarie. Si noti che è necessario liberare il buffer anche se la funzione ha esito negativo con ERROR_MORE_DATA.

[in] PreferedMaximumSize

Lunghezza massima preferita, in byte, dei dati da restituire. Se viene specificato MAX_PREFERRED_LENGTH , la funzione alloca la quantità di memoria necessaria per i dati. Se in questo parametro viene specificato un altro valore, può limitare il numero di byte restituiti dalla funzione. Se le dimensioni del buffer non sono sufficienti per contenere tutte le voci, la funzione restituisce ERROR_MORE_DATA. Per altre informazioni, vedere Buffer delle funzioni di gestione di rete e lunghezze del buffer delle funzioni di gestione di rete.

[out] EntriesRead

Puntatore a un valore che riceve il conteggio degli elementi effettivamente enumerati.

[out] TotalEntries

Puntatore a un valore che riceve il numero totale di voci che potrebbero essere state enumerate dalla posizione di ripresa corrente. Si noti che le applicazioni devono considerare questo valore solo come hint.

[in, out] ResumeHandle

Puntatore a un valore che contiene un handle di ripresa utilizzato per continuare la ricerca. L'handle deve essere zero nella prima chiamata e lasciare invariato per le chiamate successive. Se ResumeHandle è NULL, non viene archiviato alcun handle di ripresa.

Valore restituito

Se la funzione ha esito positivo, il valore restituito viene NERR_Success.

Se la funzione ha esito negativo, il valore restituito è un codice di errore di sistema. Per un elenco dei codici di errore, vedere Codici errore di sistema.

Codice restituito	Descrizione
ERROR_INVALID_PARAMETER	Alla funzione è stato passato un parametro non valido. Questo errore viene restituito se un puntatore NULL viene passato nei parametri BufPtr o entriesread .
ERROR_MORE_DATA	Sono disponibili altri dati da restituire. Questo errore viene restituito se le dimensioni del buffer non sono sufficienti per contenere tutte le voci.
ERROR_NOT_SUPPORTED	La richiesta non è supportata. Questo errore viene restituito se il parametro UncServerName non è NULL e il server remoto non supporta le chiamate RPC remote usando il meccanismo legacy remote Access Protocol.
Altri	Usare FormatMessage per ottenere la stringa del messaggio per l'errore restituito.

Commenti

Non è necessaria alcuna appartenenza speciale al gruppo per chiamare la funzione NetUseEnum . Questa funzione non può essere eseguita in un server remoto, ad eccezione dei casi di compatibilità di livello inferiore usando il protocollo di accesso remoto legacy.

Per recuperare informazioni su una connessione di rete, è possibile chiamare la funzione NetUseGetInfo .

Questa funzione si applica solo al client Server Message Block (LAN Manager Workstation). La funzione NetUseEnum non supporta le condivisioni DFS (Distributed File System). Per enumerare le condivisioni usando un provider di rete diverso (WebDAV o una condivisione DFS, ad esempio), usare le funzioni WNetOpenEnum, WNetEnumResource e WNetCloseEnum .

Requisiti


Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	lmuse.h (include Lm.h, Lmcons.h)
Libreria	Netapi32.lib
DLL	Netapi32.dll