TP1/Client/W

(a) TP1/Client/W

_s version of the function

 
#include <dcvclt.h>
DCLONG dc_clt_receive_s(DCCLT_ID cltid, char *buff,
                        DCLONG recvleng, DCLONG timeout,
                        DCLONG flags)
 

Non-_s version of the function

 
#include <dcvclt.h>
int dc_clt_receive(char *buff, DCLONG recvleng, 
                               DCLONG timeout,
                               DCLONG flags)
 

(b) TP1/Client/P

_s version of the function

 
#include <dcvclt.h>
DCLONG dc_clt_receive_s(DCCLT_ID cltid, char CLTFAR *buff,
                        DCLONG recvleng, DCLONG timeout, 
                        DCLONG flags)
 

Non-_s version of the function

 
#include <dcvclt.h>
int dc_clt_receive(char CLTFAR *buff, DCLONG recvleng,
                   DCLONG timeout,
                   DCLONG flags)
 

Receives messages sent by an MHP.

Before issuing thedc_clt_receive_s function, the dc_rpc_open_s function with flags set to DCCLT_ONEWAY_RCV or DCCLT_SNDRCV must be issued.

• cltid
  Set the client ID received by the dc_clt_cltin_s function.
  
• buff
  Set the area that contains messages received. The area must be greater than the length specified in recvleng.
  
• recvleng
  Set the length of a message to be received.
  
• timeout
  Set the maximum wait time (in seconds) for a message to receive. The value must be an integer from -1 to 65535.
  If -1 is specified, the function waits indefinitely until a message comes. If 0 is specified, the function does not wait for a message. If there is no message to receive, the function returns with a DCCLTER_TIMED_OUT error.
  If any value between 1 and 65535 is specified, the function waits for a message to receive by the number of seconds specified. If no message can be received within the specified number of seconds, the function returns with a DCCLTER_TIMED_OUT error.
  
• flags
  Specify whether to release the connection after message reception.
  

  DCNOFLAGS

  Does not release the connection after message reception.

  DCCLT_RCV_CLOSE

  Releases the connection after message reception.

  Except error situations, specifying DCNOFLAGS maintains the connection until you issue the dc_rpc_close_s function.
  

• buff
  Return the received message.
  

Return Value	Value (decimal)	Meaning
DC_OK	0	Normal termination
DCCLTER_INVALID_ARGS	-2501	Invalid argument
DCCLTER_PROTO	-2502	The dc_rpc_open_s function has not been issued. Or else, the dc_rpc_open_s function has been issued with DCCLT_ONEWAY_RCV or DCCLT_SNDRCV not specified in flags.
DCCLTER_NO_BUFS	-2504	Insufficient memory
DCCLTER_NET_DOWN	-2506	Network error
DCCLTER_TIMED_OUT	-2507	Timeout occurred during reception of the message.
DCCLTER_SYSERR	-2518	System error
DCCLTER_RESOURCE	-2538	Insufficient resource
DCCLTER_CONNFREE	-2542	Connection was freed by the remote system.
DCCLTER_INVALID_CLTID	-2544	The client ID specified for cltid differs from the one received by the dc_clt_cltin_s function.

• The dc_clt_receive_s function returns control to the CUP if any of the following events occurs:
  
  • A message of the length specified in recvleng is received from the MHP.
    Control is not returned to the CUP if the received message is shorter than the specified length.
    
  • A timeout error occurs when a message from the MHP is received.
  • The MHP frees the connection.
    (Control is not returned to the CUP if the received message is shorter than the specified length.)
    
  • A network error occurs.
• If the MHP frees the connection when the dc_clt_receive_s function is issued, the function returns with a DCCLTER_CONNFREE error.