Export (0) Print
Expand All
Expand Minimize

NetMessageNameEnum function

[This function is not supported as of Windows Vista because the messenger service is not supported.]

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

Syntax


NET_API_STATUS NetMessageNameEnum(
  _In_     LPCWSTR servername,
  _In_     DWORD level,
  _Out_    LPBYTE *bufptr,
  _In_     DWORD prefmaxlen,
  _Out_    LPDWORD entriesread,
  _Out_    LPDWORD totalentries,
  _Inout_  LPDWORD resume_handle
);

Parameters

servername [in]

Pointer to a constant string that specifies the DNS or NetBIOS name of the remote server on which the function is to execute. If this parameter is NULL, the local computer is used.

level [in]

Specifies the information level of the data. This parameter can be one of the following values.

ValueMeaning
0

Return message aliases. The bufptr parameter points to an array of MSG_INFO_0 structures.

1

Return message aliases. The bufptr parameter points to an array of MSG_INFO_1 structures. This level exists only for compatibility. Message forwarding is not supported.

 

bufptr [out]

Pointer to the buffer that receives the data. The format of this data depends on the value of the level parameter. This buffer is allocated by the system and must be freed using the NetApiBufferFree function. Note that you must free the buffer even if the function fails with ERROR_MORE_DATA.

prefmaxlen [in]

Specifies the preferred maximum length of the returned data, in bytes. If you specify MAX_PREFERRED_LENGTH, the function allocates the amount of memory required for the data. If you specify another value in this parameter, it can restrict the number of bytes that the function returns. If the buffer size is insufficient to hold all entries, the function returns ERROR_MORE_DATA. For more information, see Network Management Function Buffers and Network Management Function Buffer Lengths.

entriesread [out]

Pointer to a value that receives the count of elements actually enumerated.

totalentries [out]

Pointer to a value that receives the total number of entries that could have been enumerated from the current resume position. Note that applications should consider this value only as a hint.

resume_handle [in, out]

Pointer to a value that contains a resume handle which is used to continue an existing message alias 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 value

If the function succeeds, the return value is NERR_Success.

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

Return codeDescription
ERROR_ACCESS_DENIED

The caller does not have the appropriate access to complete the operation.

ERROR_INVALID_LEVEL

The value specified for the level parameter is invalid.

ERROR_INVALID_PARAMETER

A parameter is incorrect.

ERROR_MORE_DATA

More entries are available. Specify a large enough buffer to receive all entries.

ERROR_NOT_ENOUGH_MEMORY

Insufficient memory is available.

ERROR_NOT_SUPPORTED

This request is not supported. This error is returned on Windows Vista and later.

NERR_BufTooSmall

The supplied buffer is too small.

 

Remarks

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

To retrieve information about a particular message alias in the message name table, you can call the NetMessageNameGetInfo function.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

End of client support

Windows XP

End of server support

Windows Server 2003

Header

Lmmsg.h (include Lm.h)

Library

Netapi32.lib

DLL

Netapi32.dll

See also

Network Management Overview
Network Management Functions
Message Functions
MSG_INFO_0
MSG_INFO_1
NetMessageNameGetInfo

 

 

Community Additions

ADD
Show:
© 2014 Microsoft