NetMessageNameEnum

The NetMessageNameEnum function lists the message aliases that will receive messages on a specified computer. This function requires that the Messenger service be started.

Security Requirements

Only members of the Administrators local group can successfully execute NetMessageNameEnum on a remote server.

NET_API_STATUS NetMessageNameEnum(
  LPWSTR servername,     
  DWORD level,           
  LPBYTE *bufptr,        
  DWORD prefmaxlen,      
  LPDWORD entriesread,   
  LPDWORD totalentries,  
  LPDWORD resume_handle  
);
 

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.
level
Specifies one of the following values to return the requested level of information provided.
Value Meaning
0 The bufptr parameter points to an array of MSG_INFO_0 structures.
1 The bufptr parameter points to an array of MSG_INFO_1 structures.

bufptr
Points to the buffer in which the data set with the level parameter is stored.
prefmaxlen
Preferred maximum length, in 8-bit bytes of returned data.
entriesread
Pointer to a DWORD that contains the actual enumerated element count.
totalentries
Pointer to a DWORD that contains the total number of entries that could have been enumerated from the current resume position.
resume_handle
Pointer to a DWORD that contains resume_handle, which is used to continue an existing message name search. The handle should be zero on the first call and left unchanged for subsequent calls. If resume_handle is NULL, no resume handle 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_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.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in lmmsg.h.
  Import Library: Use netapi32.lib.

See Also

Networking (Net) Overview, Net Functions, NetMessageNameGetInfo