4.7.2 dc_clt_cancel_notification_s − 一方通知待ち状態のキャンセル
- 〈この項の構成〉
(1) 形式
(a) TP1/Client/Wの場合
■ _s付き関数
#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)
■ _s無し関数
#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付き関数
#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)
■ _s無し関数
#include <dcvclt.h> DCLONG dc_clt_cancel_notification( char CLTFAR *inf, DCLONG inf_len, unsigned short port, char CLTFAR *hostname, DCLONG flags)
(2) 機能
dc_clt_accept_notification_s関数,またはdc_clt_chained_accept_notification_s関数を発行し,サーバからの一方通知待ち状態になっているCUPの,待ち状態をキャンセルします。解除するときに,引数infに指定したメッセージを一方通知受信待ち状態のCUPに通知できます。
(3) UAPで値を設定する引数
-
hWnd
NULLを指定します。
-
defpath
クライアント環境定義ファイルへのパス名を指定します。パス名には完全パス,またはカレントドライブ・ディレクトリからの相対パスが指定できます。パス名を指定した場合のファイルの読み込み順序を次に示します。
-
TP1/Client/Pの場合
クライアント環境定義ファイルの読み込み順序は次のとおりです。
1.WindowsディレクトリのBETRAN.INIファイル
2.引数defpathに指定したクライアント環境定義ファイル
定義は,クライアント環境定義ファイルおよびBETRAN.INIファイルのどちらのファイルに指定しても有効です。
両方のファイルに同じ定義を異なる値で指定した場合は,クライアント環境定義ファイルに指定した値が有効となります。
クライアント環境定義ファイルおよびBETRAN.INIファイルのどちらにも指定がない場合は,デフォルト値で動作します。
-
TP1/Client/Wの場合
環境変数に指定されている定義は,すべて無効となります。引数defpathに指定したクライアント環境定義ファイルに指定されていない定義はデフォルト値で動作します。
また,引数defpathの先頭にNULLを指定することでパス名を省略できます。省略時の動作を次に示します。
-
TP1/Client/Pの場合
WindowsディレクトリのBETRAN.INIファイルをクライアント環境定義ファイルとして動作します。BETRAN.INIファイルがない場合,または定義ファイルの内容が不正な場合はデフォルト値で動作します。
-
TP1/Client/Wの場合
環境変数の指定で動作します。環境変数が指定されていない場合は,デフォルト値で動作します。
引数defpathに指定したクライアント環境定義ファイルがない場合,または定義ファイルの内容が不正な場合の動作を次に示します。
-
TP1/Client/Pの場合
WindowsディレクトリのBETRAN.INIファイルをクライアント環境定義ファイルとして動作します。BETRAN.INIファイルがない場合,または定義ファイルの内容が不正な場合は,デフォルト値で動作します。
-
TP1/Client/Wの場合
デフォルト値で動作します。環境変数の指定は無効となります。
-
-
inf
CUPに通知するメッセージを指定します。
-
inf_len
メッセージ長(infの長さ)を指定します。0からDCRPC_MAX_MESSAGE_SIZE※の範囲で指定します。
0を指定した場合はCUPにメッセージを通知しません。
- 注※
-
クライアント環境定義DCCLTRPCMAXMSGSIZEに2以上を指定した場合,DCRPC_MAX_MESSAGE_SIZEの値(1メガバイト)ではなく,クライアント環境定義DCCLTRPCMAXMSGSIZEに指定した値になります。
-
port
一方通知受信要求時に指定したポート番号を指定します。5001から65535の範囲で指定します。
-
hostname
一方通知受信待ち状態のCUPが存在するホスト名を指定します。ホスト名として指定できる長さは,63文字※までです。
ホスト名として,10進ドット記法のIPアドレスを指定することもできます。
- 注※
-
クライアント環境定義DCCLTOPTIONに00000008を指定した場合,ホスト名として指定できる長さは255文字までとなります。
-
flags
DCNOFLAGSを指定します。
(4) リターン値
リターン値 |
数値 (10進数) |
意味 |
---|---|---|
DC_OK |
0 |
正常終了しました。 |
DCCLTER_INVALID_ARGS |
-2501 |
引数に指定した値が誤っています。 |
DCCLTER_FATAL |
-2503 |
初期化に失敗しました。または,クライアント環境定義の指定に誤りがあります。 |
DCCLTER_NO_BUFS |
-2504 |
必要なバッファが確保できませんでした。または,リソース不足が発生しました。 |
DCCLTER_NET_DOWN |
-2506 |
ネットワーク障害が発生しました。 |
DCCLTER_SERVICE_NOT_UP |
-2514 |
CUPが一方通知受信待ち状態ではありません。 |
DCCLTER_SYSERR |
-2518 |
システムエラーが発生しました。 |
DCCLTER_WRONG_HOST |
-2539 |
ホスト名が不正です。 |
DCCLTER_PORT_IN_USE |
-2547 |
OSが自動的に割り当てるポート番号が不足しています。 |
(5) 注意事項
TP1/Clientでは,dc_clt_cancel_notification_s関数の呼び出しごとにクライアント環境定義を定義できます。dc_clt_cancel_notification_s関数の呼び出しごとにクライアント環境定義を定義するには,dc_clt_cancel_notification_s関数の呼び出しごとに,異なるファイルをクライアント環境定義ファイルとして作成して,そのファイル名をdc_clt_cancel_notification_s関数の引数defpathに指定してください。