NetMessageBufferSend or Net32MessageBufferSend

The NetMessageBufferSend API sends a buffer of information to a registered messaging name.

Restrictions

This API can be called from DLS and OS/2 workstations. This API requires the caller to have either administrator authority or P permission to the parent directory. However, no access authority is required for local execution.

Syntax

#include <netcons.h>
#include <message.h>
 
NetMessageBufferSend(pszServername, name,
                       buf, usBuflen);  /* 16 bit */
 
Net32MessageBufferSend(pszServername, name,
                       buf, ulBuflen);  /* 32 bit */

Parameters

See Common Parameter Definitions for descriptions of parameters not defined here.

name

(unsigned char LSFAR *) points to an ASCIIZ string containing the name of the user or application to receive the message. To broadcast a message to all requesters on the LAN, have name point to an asterisk (wildcard). To broadcast a message to all users on a domain, have name point to a domain name followed by an asterisk (*). The name parameter cannot be null.
buf
(unsigned char LSFAR *) points to the ASCIIZ message to be sent.
Return Codes

The following table lists the return codes most significant to this API. (See API Return Codes for a complete list of return codes.) ┌─────────────────────────────┬───────┬────────────────────────────────────────┐│SYMBOLICCONSTANT │VALUE│MEANING │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_Success │ 0 │ No errors were encountered. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_ACCESS_DENIED │ 5 │ Administrator privilege is required. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_NOT_ENOUGH_MEMORY │ 8 │ Sufficient memory is not available. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_REM_NOT_LIST │ 51 │ This remote computer is not listening. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_INVALID_PARAMETER │ 87 │ At least one parameter value is not │
│ │ │ valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ ERROR_INVALID_LEVEL │ 124 │ The sLevel parameter is not valid. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NetNotStarted │ 2102 │ The redirector NETWKSTA.200 has not │
│ │ │ been started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_ShareMem │ 2104 │ An internal error occurred-the network │
│ │ │ cannot access a shared memory segment. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NoNetworkResource │ 2105 │ A network resource shortage occurred. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BufTooSmall │ 2123 │ The buffer is too small for fixed- │
│ │ │ length data. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_RemoteErr │ 2127 │ A remote API error has occurred. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_OS2IoctlError │ 2134 │ An internal error occurred when │
│ │ │ calling the workstation driver. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NetworkError │ 2136 │ A general network error has occurred. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_WkstaNotStarted │ 2138 │ The Requester service has not been │
│ │ │ started. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BrowserNotStarted │ 2139 │ The requested information is not │
│ │ │ available. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_InternalError │ 2140 │ An internal error has occurred. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BadTransactConfig │ 2141 │ The server is not configured for │
│ │ │ transactions. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NoComputerName │ 2270 │ A computer name has not been config- │
│ │ │ ured. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NameNotFound │ 2273 │ The message alias cannot be found on │
│ │ │ the local area network. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_AlreadyExists │ 2276 │ This message alias already exists │
│ │ │ locally. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_TooManyNames │ 2277 │ The maximum number of added message │
│ │ │ aliases has been exceeded. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_PausedRemote │ 2281 │ The message has been sent, but the │
│ │ │ reception is currently paused. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_BadReceive │ 2282 │ The message was sent but not received. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_NotLocalName │ 2285 │ The name is not on the local computer. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_TruncatedBroadcast │ 2289 │ The broadcast message was truncated. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_DuplicateName │ 2297 │ A duplicate message alias exists on │
│ │ │ the local area network. │
├─────────────────────────────┼───────┼────────────────────────────────────────┤
│ NERR_InvalidComputer │ 2351 │ The specified computer name is not │
│ │ │ valid. │
└─────────────────────────────┴───────┴────────────────────────────────────────┘


Other codes could be returned from the following functions:

• DosFsRamSemClear
  
• DosFreeSeg
  
• DosFsCtl
  
• DosGetShrSeg
  
• DosSemClear
  
• DosMailslot
Remarks

For broadcast messages to the physical network, where name points to "*" or to "domain (*)", the message can be no longer than 128 bytes (and is not guaranteed to be delivered). For messages sent to all message names on a domain, the limit is 128 bytes. Otherwise, the message can be any length, provided it does not exceed the maximum receivable message size for that computer, which is set with the sizmessbuf parameter in the IBMLAN.INI file. The total size of sizmessbuf can be divided among different messages in its heap, if messages are arriving at the same time. This reduces the actual size of any single message that can be received. In addition, the sizmessbuf parameter can accept only limited values.

NetMessageBufferSend does not require the Messenger service to be started on a local computer.

Related Information

For information about:

• Adding a user to a message table, see Message - NetMessageNameAdd.

• Using the Messenger service, see Services Category.

• Sending a message file to a user, see Message - NetMessageFileSend.

• Setting the sizmessbuf parameter of a server in the IBMLAN.INI file, see the LAN Server Network Administrator Reference Volume 2: Performance Tuning.

---

[Back: Related Information]
[Next: NetMessageFileSend or Net32MessageFileSend]