Cicode Programming Reference > Cicode Function Categories > Task Functions Introduction > MsgGetCurr

MsgGetCurr

Gets the handle of the client message that called the report or remote procedure that is currently running. You can call this function only in a report or a remote procedure call.

If the report was called by a client, this function returns that client message handle. The report can then send a message back to the client. If a function was called remotely by MsgRPC(), this function returns the message handle for the remote client.

Syntax

MsgGetCurr()

Return Value

The handle for the client message. The message handle identifies the table where all data on the associated message is stored. The function returns -1 if no client called the report or function.

Related Functions

MsgOpen, MsgRPC

Example

! Send message back to the client.
hMsg=MsgGetCurr();
IF hMsg<>-1 THEN
MsgRPC(hMsg,"Prompt","^"Hello Client from Report Server^"",1);
END

See Also

Task Functions