Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles
(untagged)

A brief discussion on how to use three of the network management functions

0.00/5 (No votes)
2 May 2004 1  
A brief discussion on how to use NetShareEnum, NetConnectionEnum, and NetFileEnum

Introduction

This article is just a brief discussion on the use of three network management functions: NetShareEnum(), NetConnectionEnum(), and NetFileEnum(). The first two can be used together to get a list of shared resources on a given server, and then to get a list of connections made to each of those shares. The last one is used to get a list of open files on a server. You can see examples of these using the Computer Management snap-in.

Listing Shares

To get a listing of shared resources on a server, including ones on which the function is running, use NetShareEnum(). As the name implies, it enumerates network shares. It's used like:

DWORD          dwStatus,
               dwReadEntries,
               dwTotalEntries,
               dwIndex;
LPSHARE_INFO_2 pShareBuffer,
               pShareTemp;

dwStatus = NetShareEnum(_T("solomon"),
                        2,
                        (LPBYTE *) &pShareBuffer,
                        MAX_PREFERRED_LENGTH,
                        &dwReadEntries,
                        &dwTotalEntries,
                        NULL);
if (NERR_Success == dwStatus && dwSharesRead > 0)
{
    pShareTemp = pShareBuffer;
    for (dwIndex = 0; dwIndex < dwReadEntries; dwIndex++, pShareTemp++)
        ...

    NetApiBufferFree(pShareBuffer);
}

Something to note about this function, and the other two, is that the server name need not begin with \\. MSDN states that it must, but my testing found that either way was acceptable.

The fourth parameter, prefmaxlen, indicates how much data is to be returned. I couldn't find any reason to not use MAX_PREFERRED_LENGTH here. Maybe in times past with limited amounts of available RAM.

Listing Connections to Shares

To get a listing of connections to each of the shares gathered earlier, use NetConnectionEnum(). As the name implies, it enumerates connections to network shares. It's used like:

DWORD               dwStatus,
                    dwConnectionsRead,
                    dwTotalConnections;
LPCONNECTION_INFO_1 pConnBuffer,
                    pConnTemp;

dwStatus = NetConnectionEnum(_T("solomon"),
                             pShareTemp->shi2_netname,
                             1,
                             (LPBYTE *) &pConnBuffer,
                             MAX_PREFERRED_LENGTH,
                             &dwConnectionsRead,
                             &dwTotalConnections,
                             NULL);
if (NERR_Success == dwStatus && dwConnectionsRead > 0)
{
    pConnTemp = pConnBuffer; 
    while (dwConnectionsRead > 0)    
    {        
        ...        
        dwConnectionsRead--;        
        pConnTemp++;
    } 

    NetApiBufferFree(pConnBuffer);
} 

The second parameter, qualifier, is the name of a share returned by the previous call to NetShareEnum(). Putting these two functions together yields something like the following. I used a tree control so that the relationship between a share and its connection(s) could be seen.

Listing Open Files

To get a listing of open files on a server, use NetFileEnum(). As the name implies, it enumerates files on a network. It's used like:

DWORD         dwIndex,
              dwStatus,
              dwReadEntries,
              dwTotalEntries;
LPFILE_INFO_3 pBuffer,
              pCurrent;

dwStatus = NetFileEnum(_T("solomon"),
                       NULL,
                       NULL,
                       3,
                       (LPBYTE *) &pBuffer,
                       MAX_PREFERRED_LENGTH,
                       &dwReadEntries,
                       &dwTotalEntries,
                       NULL);
if (NERR_Success == dwStatus && dwReadEntries > 0)
{
    pCurrent = pBuffer;    

    for (dwIndex = 0; dwIndex < dwReadEntries; dwIndex++, pCurrent++)
        ... 
    
    NetApiBufferFree(pBuffer);
}

You can see what files are open and by whom. Something of interest regarding the fi3_permissions member of the FILE_INFO_3 structure is that it can have four more values than are noted by MSDN. Those values are ACCESS_EXEC, ACCESS_DELETE, ACCESS_ATRIB, and ACCESS_PERM.

The output of this function produces something like:

Notes

Each of these functions behave in accordance to the membership of the calling process. If the calling process is a member of the Administrators group, all is well. Otherwise, additional code will be necessary to mimic membership of such a group. Use OpenProcessToken() and AdjustTokenPrivileges() for this.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here