OpenTP1 Version 7 TP1/Client User's Guide TP1/Client/W, TP1/Client/P

[Contents][Index][Back][Next]

4.7.2 dc_clt_cancel_notification_s - Canceling one-way message wait

Organization of this subsection
(1) Form
(2) Purpose
(3) Arguments set by UAPs
(4) Return values
(5) Note

(1) Form

(a) TP1/Client/W
_s version of the function
 
#include <dcvclt.h>
DCLONG dc_clt_cancel_notification_s(
                           HWND hWnd, char *defpath,
                           char *inf, DCLONG inf_len,
                           unsigned short port,
                           char *hostname, DCLONG flags)
 
Non-_s version of the function
 
#include <dcvclt.h>
DCLONG dc_clt_cancel_notification(
                          char *inf, DCLONG inf_len, 
                          unsigned short port, char 
                          *hostname,
                          DCLONG flags)
 
(b) TP1/Client/P
_s version of the function
 
#include <dcvclt.h>
DCLONG dc_clt_cancel_notification_s(
                         HWND hWnd, char CLTFAR *defpath,
                         char CLTFAR *inf, DCLONG inf_len, 
                         unsigned short port,
                         char CLTFAR *hostname, DCLONG 
                         flags)
 
Non-_s version of the function
 
#include <dcvclt.h>
DCLONG dc_clt_cancel_notification(
                          char CLTFAR *inf, DCLONG inf_len, 
                          unsigned short port, char CLTFAR 
                          *hostname,
                          DCLONG flags)
 

(2) Purpose

Cancels the wait for receiving a one-way message from the server. The wait state is enabled by the dc_clt_accept_notification_s function.

When canceling the wait state, you can send the message specified for inf to the CUP that waits for a one-way message.

(3) Arguments set by UAPs

(4) Return values

Return Value Value (decimal) Meaning
DC_OK 0 Normal termination
DCCLTER_INVALID_ARGS -2501 Invalid argument
DCCLTER_FATAL -2503 Initialization failed. Alternatively, the client environment definition is specified incorrectly.
DCCLTER_NO_BUFS -2504 A necessary amount of buffer could not be allocated. Alternatively, resources became insufficient.
DCCLTER_NET_DOWN -2506 Network error
DCCLTER_SERVICE_NOT_UP -2514 The CUP is not in the one-way message reception wait status.
DCCLTER_SYSERR -2518 System error
DCCLTER_WRONG_HOST -2539 Invalid host computer name
DCCLTER_PORT_IN_USE -2547 The specified port number is in use, or port numbers that can be assigned automatically by the operating system are insufficient.

(5) Note

In TP1/Client, you can use a different client environment definition for each dc_clt_cancel_notification_s function call. To do so, create a separate client environment definition file for each dc_clt_cancel_notification_s function call, and specify the file name in the defpath argument of the function.