Gx5731GetPortWord

Purpose

Reads a port word value.

Syntax

Gx5731GetPortWord (nHandle, nPort, nWord, pwValue, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX5731 board.
nPort
SHORT
Digital I/O port numbers are as follow:
  • Digital I/O port numbers 3-6.
  • Any port number 0 to 2 that has no I/O module installed.
nWord
SHORT
Port word number: 0-1. Where 0 is for low order word (bytes 0 and 1) and 1 for the high order word (bytes 2 and 3).
pwValue
PWORD
Returned port word value: 0 to 65,535 (0-0xFFFF). Where bit 0 corresponds to channel 0 and bit 15 to channel 15.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

Use the Gx5731SetPortWord to write data to the port word when in Output direction.

Example

The following example reads port 1, word 0 value:

 

SHORT nStatus;

WORD wValue;

Gx5731GetPortByte (nHandle, 1, 0, &wValue, &nStatus);

 

See Also

Gx5731SetPortWord, Gx5731GetPortBit, Gx5731GetPortByte, Gx5731GetPort