NetMessageNameGetInfo function (lmmsg.h)

Article
10/13/2021

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

The NetMessageNameGetInfo function retrieves information about a particular message alias in the message name table. The function requires that the messenger service be started.

Syntax

NET_API_STATUS NET_API_FUNCTION NetMessageNameGetInfo(
  [in]  LPCWSTR servername,
  [in]  LPCWSTR msgname,
  [in]  DWORD   level,
  [out] LPBYTE  *bufptr
);

Parameters

[in] servername

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.

[in] msgname

Pointer to a constant string that specifies the message alias for which to return information.

[in] level

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

Value	Meaning
0	Return the message alias. The bufptr parameter points to a MSG_INFO_0 structure.
1	Return the message alias. The bufptr parameter points to a MSG_INFO_1 structure. This level exists only for compatibility. Message forwarding is not supported.

[out] bufptr

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. For more information, see Network Management Function Buffers and Network Management Function Buffer Lengths.

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 code	Description
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_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_NotLocalName	The message alias is not on the local computer.

Remarks

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

To list all the message aliases in a message name table, you can call the NetMessageNameEnum function.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	lmmsg.h (include Lm.h)
Library	Netapi32.lib
DLL	Netapi32.dll