FLStopCommand        Method to stop a running FileLink script command

Overview

Method to cancel a pending script command from previous non-blocking FLSendCommand().

C++ Definition

long FLStopCommand( )

VB Definition

FLStopCommand() As Long

Return Value

A numeric value indicating the success or failure of initiating the cancellation of a FileLink script command.

Returns FL_ERROR_SUCCESS if a stop is initiated -- this does not mean the command has been stopped, rather only that the request has been successfully passed to FileLink

Returns FL_ERROR_NO_CMD_PENDING if no script command is currently in progress that can be stopped.

See COM/OLE Return Codes for a complete list of possible return values.

Parameters

None.

Remarks

The FLStartSession() and FLSendCommand() methods must be called prior to calling FLStopCommand().

This method returns immediately. The FileLink command may or may not terminate depending on when this method is called. The effect of calling this method is same as pressing the Esc key or clicking the Stop button when FileLink is running interactively. If the command terminates, the FLSendCommand() completion event is fired with the corresponding FileLink result code.