dc_mcf_timer_cancel - Cancel user timer monitoring

OpenTP1 Version 7 Programming Reference C Language

dc_mcf_timer_cancel - Cancel user timer monitoring

Format

ANSI C, C++

#include <dcmcf.h>
int dc_mcf_timer_cancel(DCLONG flags,DCLONG timer_id,char *lename)

K&R C

#include <dcmcf.h>
int dc_mcf_timer_cancel(flags,timer_id,lename)
DCLONG    flags;
DCLONG    timer_id;
char      *lename;

Description

The function dc_mcf_timer_cancel() cancels user timer monitoring that was set by the function dc_mcf_timer_set().

This function cancels user timer monitoring as soon as the function dc_mcf_timer_cancel() returns normally.

If user timer monitoring has reached timeout and an MHP has already been started at the time this function is called, the function dc_mcf_timer_cancel() returns with the error DCMCFER_PARAM_TIM_ID.

Only a user server can call the function dc_mcf_timer_cancel().

Arguments whose values are set in the UAP

flags

Specify DCNOFLAGS.

timer_id

Specify the same timer request identifier as that specified when user timer monitoring was set.

lename

Specify the same logical terminal name as that specified when user timer monitoring was set.

Return values

Return value	Return value (numeric)	Explanation
DC_OK	0	Normal termination.
DCMCFER_PARAM_FLAGS	-11911	The value specified for flags is invalid.
DCMCFER_PARAM_TIM_ID	-11910	The timer request identifier specified for timer_id is not registered.
DCMCFER_PARAM_TIM_ID	-11910	Timeout already occurred and the MHP has started, or user timer monitoring was already canceled.
DCMCFER_PARAM_LENAME	-11912	The value specified for lename is invalid.
DCMCFER_NO_DEFINE	-11916	The requested facility is not defined in the MCF.