NetShareGetInfo

The NetShareGetInfo function retrieves information about a particular shared resource on a server.

Security Requirements

Only members of the Administrators or Account Operators local group or those with Communication, Print, or Server operator group membership can successfully execute NetShareGetInfo at level 2. No special group membership is required for calls in SHARE_INFO_0 and SHARE_INFO_1.

NET_API_STATUS NetShareGetInfo(
  LPWSTR servername,  
  LPWSTR netname,     
  DWORD level,        
  LPBYTE *bufptr      
);
 

Parameters

servername
Pointer to a Unicode string containing the name of the remote server on which the function is to execute. A NULL pointer or string specifies the local computer.
netname
Pointer to a Unicode string containing the network name of the share on which to return information.
level
Specifies one of the following values to return the level of information available.
Value Meaning
0 The bufptr parameter points to an array of SHARE_INFO_0 structures.
1 The bufptr parameter points to an array of SHARE_INFO_1 structures.
2 The bufptr parameter points to an array of SHARE_INFO_2 structures.
501 The bufptr parameter points to an array of SHARE_INFO_501 structures.
502 The bufptr parameter points to an array of SHARE_INFO_502 structures.

bufptr
Pointer to the buffer in which the data set with the level parameter is stored.

Return Values

If the function returns account information, the return value is NERR_Success.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_ACCESS_DENIED The user does not have access to the requested information.
ERROR_INVALID_LEVEL The value specified for the Level parameter is invalid.
ERROR_INVALID_PARAMETER The specified parameter is invalid.
ERROR_MORE_DATA More entries are available with subsequent calls.
ERROR_NOT_ENOUGH_MEMORY Insufficient memory is available.
NERR_BufTooSmall The supplied buffer is too small.
NERR_NetNameNotFound The sharename does not exist.

Remarks

You need to free the memory pointed to by bufptr. Use the NetAPIBufferFree function to free the pointer.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in lmshare.h.
  Import Library: Use netapi32.lib (Windows NT) or svrapi.lib (Windows 95).

See Also

Networking (Net) Overview, Net Functions