srv_sendmsg

Sends a message to the client.

Syntax

int srv_sendmsg ( SRV_PROC * srvproc,
int msgtype,
DBINT msgnum,
DBTINYINT class,
DBTINYINT state,
DBCHAR * rpcname,
int rpcnamelen,
DBUSMALLINT linenum,
DBCHAR * message,
int msglen );

Arguments

srvproc

Is a pointer to the SRV_PROC structure that is the handle for a particular client connection (in this case, the handle that received the language request). The structure contains information that the ODS Library uses to manage communication and data between the Open Data Services server application and the client.

msgtype

Is either SRV_MSG_INFO or SRV_MSG_ERROR, depending on whether the server is sending an informational or error message.

msgnum

Is a 4-byte message number.

class

Specifies the error severity. A severity less than or equal to 10 is considered an informational message.

state

Provides the error state number for the current message. The error state number provides information about the context of the error. Valid state numbers are from 1 through 127.

rpcname

Is currently not supported.

rpcnamelen

Is currently not supported.

linenum

Is the line number in the language command batch where the message applies. Line numbers start at 1. If linenum does not apply to the message, set to 0.

message

Is a pointer to the character string to be sent to the client.

msglen

Specifies the length, in bytes, of message. If message is null-terminated, set msglen to SRV_NULLTERM.

Returns

SUCCEED or FAIL

Remarks

This function sends error or informational messages to the client. It is called once for each message to be sent.

Messages sent with srv_sendmsg can be sent to the client in any order before or after all rows (if any) have been sent with srv_sendrow. All messages, if any, must be sent to the client before the completion status is sent with srv_senddone.

If the error message in your application is in unicode, you need to convert it to the multibyte code page of the server before calling srv_sendmsg since message is defined as DBCHAR*.

If the error message in your application is in unicode, convert it to the multibyte code page of the server before calling srv_sendmsg since message is defined as DBCHAR*. For more information see Unicode Data and Server Code Pages.