OpenTP1 Version 7 Programming Reference C Language
dc_mcf_tdlqle - Delete a logical terminal's output queue
Format
ANSI C, C++
#include <dcmcf.h> int dc_mcf_tdlqle (DCLONG action, dcmcf_tdlqleopt *leopt, char *resv01, DCLONG *resv02, char *resv03, char *resv04) |
K&R C
#include <dcmcf.h> int dc_mcf_tdlqle (action, leopt, resv01, resv02, resv03, resv04) DCLONG action; dcmcf_tdlqleopt *leopt; char *resv01; DCLONG *resv02; char *resv03; char *resv04; |
Description
The dc_mcf_tdlqle() function deletes a logical terminal's output queue.
When the function deletes the output queue successfully, it sends an event that reports that unprocessed send messages have been discarded (ERREVTA).
Arguments whose values are set in the UAP
action
Specify DCMCFLE to indicate that a logical terminal name is being specified.
leopt
Set in a dcmcf_tdlqleopt structure the connection information about the logical terminal that is to be the subject of this function's processing.
The following shows the format of the structure:
typedef struct { DCLONG mcfid; ...MCF communication process identifier char resv01[4]; ...Reserved char idnam[9]; ...Logical terminal name char resv02[7]; ...Reserved char resv03[112]; ...Reserved char resv04[376]; ...Reserved } dcmcf_tdlqleopt;
resv01, resv02, resv03, resv04
Specify NULL.
Return values
Return value | Return value (numeric) | Explanation |
---|---|---|
DCMCFRTN_00000 | 0 | Normal termination. |
DCMCFRTN_71001 | -12001 | The dc_mcf_tdlqle() function cannot be accepted because the MCF is under start processing. |
DCMCFRTN_71002 | -12002 | The dc_mcf_tdlqle() function cannot be accepted because the MCF is under termination processing. |
DCMCFRTN_71004 | -12004 | A memory shortage occurred during dc_mcf_tdlqle() function processing. |
DCMCFRTN_71005 | -12005 | A communication error occurred. For the cause, see the message log file. |
DCMCFRTN_71006 | -12006 | An internal error occurred. For the cause, see the message log file. |
DCMCFRTN_71008 | -12008 | The specified logical terminal name has not been registered. |
DCMCFRTN_71009 | -12009 | The dc_mcf_tdlqle() function is not supported by the applicable MCF communication process. |
DCMCFRTN_71010 | -12010 | Although the request to delete the logical terminal's output queue was issued to the MCF communication process, the request was not accepted. For the cause, see the message log file. |
DCMCFRTN_71011 | -12011 | The dc_mcf_tdlqle() function cannot be accepted because the logical terminal has been deleted. |
DCMCFRTN_71017 | -12017 | The dc_mcf_tdlqle() function cannot be accepted because the logical terminal has not been shut down. |
DCMCFRTN_71018 | -12018 | The dc_mcf_tdlqle() function cannot be accepted because the session has not been closed. |
DCMCFRTN_71019 | -12019 | The dc_mcf_tdlqle() function cannot be accepted because an alternate send operation is underway. |
DCMCFRTN_72050 | -13050 | DCMCFLE is not set in action. |
An unsupported flag is set in action. | ||
DCMCFRTN_72051 | -13051 | NULL is set in leopt. |
DCMCFRTN_72052 | -13052 | NULL is not set in resv01. |
DCMCFRTN_72053 | -13053 | NULL is not set in resv02. |
DCMCFRTN_72054 | -13054 | NULL is not set in resv03. |
DCMCFRTN_72055 | -13055 | NULL is not set in resv04. |
DCMCFRTN_72061 | -13061 | A value smaller than 0 or a value 240 or greater is specified for mcfid in dcmcf_tdlqleopt. |
DCMCFRTN_72062 | -13062 | resv01 in dcmcf_tdlqleopt is not filled with null characters. |
DCMCFRTN_72063 | -13063 | idnam in dcmcf_tdlqleopt begins with the null character. |
DCMCFRTN_72064 | -13064 | resv2 in dcmcf_tdlqleopt is not filled with null characters. |
DCMCFRTN_72065 | -13065 | resv03 in dcmcf_tdlqleopt is not filled with null characters. |
DCMCFRTN_72067 | -13067 | resv04 in dcmcf_tdlqleopt is not filled with null characters. |
DCMCFRTN_72073 | -13073 | The character string set in idnam in dcmcf_tdlqleopt is 9 or more bytes in length. |
DCMCFRTN_72074 | -13074 | The character string set in idnam in dcmcf_tdlqleopt contains an invalid character. |
All Rights Reserved. Copyright (C) 2006, 2010, Hitachi, Ltd.