ACI_GangTerminate_Params

Top  Previous  Next

typedef struct tagACI_GangTerminate_Params

{

 UINT   Size;                // (in)  Size of structure, in bytes

 INT    SiteNumber;          // (in)  Site number to terminate operation (-1 == all sites)

 INT    Timeout;             // (in)  Timeout in milliseconds (-1 == infinite) to wait for operation break

 BOOL   SiteStopped;         // (out) TRUE if operation was stopped, FALSE if timeout occurred

} ACI_GangTerminate_Params;

 

 

SiteNumber

The site (socket) number you want terminating a current operation on. Socket numbers begin from 0 (zero). If you specify SiteNumber = -1 (minus one) this will terminate operations on all sites of the gang machine.
 

Timeout

A time interval in milliseconds, during of which the ACI_GangTerminateFunction holds expecting an acknowledgment of the successful operation termination. The function will return control either upon getting such an acknowledgment or upon expiring a specified Timeout.
 

If you specify the Timeout = -1 (minus one) it will never expire.
 

SiteStopped

This parameter indicates whether the ACI_GangTerminateFunction succeeded. In case of successful termination an operation before expiring the Timeout the SiteStopped parameter sets TRUE. Otherwise, it will be set FALSE.
 

 

 

See also: ACI_GangTerminateFunction, ACI_TerminateFunction.