IAsyncMessage::Terminate

Description

Requests the session to terminate normal execution of an asynchronous I/O operation.

This operation requests a session to terminate normal execution of an operation, as specified by the jobId parameter. The jobId parameter is a unique value generated from each call to an asynchronous operation.

If a user passes 0 as the jobId value to Terminate, VISA should abort any calls executing on the session object.  Any call that is terminated this way should return E_VISA_ABORT.  Due to the nature of multithreaded systems, for example where operations in other threads may complete normally before the operation Terminate has any effect, the specified return value is not guaranteed.

VB Prototype

Terminate(
  jobId As Long
)

C++ Prototype

HRESULT Terminate(
  long jobId
);

Parameters

jobId

The job id of the asynchronous I/O operation to terminate.

Return Value

Refer to the table of return codes.

See Also

ComponentVersion, SpecVersion, HardwareInterfaceName, HardwareInterfaceNumber, HardwareInterfaceType, LockState, OptionString, ProgID, ResourceName, SessionType, SoftwareManufacturerID, SoftwareManufacturerName, Timeout, LastStatus, IOProtocol, SendEndEnabled, TerminationCharacter, TerminationCharacterEnabled, GetAttribute, SetAttribute, LockRsrc, UnlockRsrc, Init, Close, AssertTrigger, Clear, ReadSTB, Read, Write, WriteString, Terminate, IAsyncMessage Overview