DioHalt

Applies To

GC5050, GX5050, GX5055, GX5150, GX5280, GX5290, GX5290e, GX5295

Purpose

Sets the Master board to HALT state.

Syntax

DioHalt (nMasterHandle, pnStatus)

Parameters

Name

Type

Comments

nMasterHandle

SHORT

Master board handle.

pnStatus

PSHORT

Returned status: 0 on success, negative number on failure.

Comments

The DioHalt function does not change the board program counter value. Calling DioArm and DioTrig after the board is in a HALT state will cause the board to continue running from the current program counter address.

Example

The following example sets the board to the HALT state:

 

SHORT   nStatus;

DioHalt (nMasterHandle, &nStatus);

 

See Also

DioArm, DioTrig, DioReadStatusRegister