Input/Output

Function

Description
GetBinaryString(BitStream)

Returns the BitStream data structure as a list of binary digits.

Note: The returned string is for reference purposes, only. In-Sight firmware does not support binary as a number format.

GetBufferData(ReadBuffer, Index)

Returns the indexed data from a UserData, ReadDeviceNet, ReadEIP, ReadPNIO, or a ReadModbus data structure.

Note:
  • The ReadDeviceNet, ReadEIP, ReadPNIO, and ReadModbus data structures are only supported on In-Sight vision systems running firmware 4.9.3 and earlier. These data structures are not supported on vision systems running In-Sight 5.1.0 or later firmware.
  • The Event parameter for the ReadDeviceNet function must reference a cell containing the Event function. That Event function's Trigger parameter must specify Serial Port 0 or Serial Port 1, depending on the value of the ReadDeviceNet function's Port parameter. For more information, see ReadDeviceNet and Event.
GetByteCount(Buffer) Returns the number of bytes that have been written into a FormatOutputBuffer function or read into a ReadCCLinkBitBuffer, ReadCCLinkWordBuffer, ReadEIPBuffer, ReadLatchedUserDataBuffer, ReadModbusBuffer, ReadProfinetBuffer or ReadUserDataBuffer function. For more information, see FormatOutputBuffer.

GetClock(Time, Format String, [Local/GMT])

Returns the current date and time as a string constructed using a "C" library standard Format-string from a Time data structure, which is returned by the Now function.

Format String

Specifies the format for the display of the date and time. The default Format String is: month/day/year hour:minute:second, which is represented as: %m/%d/%Y %H:%M:%S

The following variables are allowed:

%m

month

%d

day

%Y

year

%H

hour

%M

minute

%S

second
%3N millisecond
%6N microsecond
%9N nanosecond
Local/GMT

0 = Local with Daylight Saving Time (default)

1 = GMT (UTC)

2 = Local with Standard Time
GetConnectionStatus(Event, Protocol)

Returns the connection status of the specified communication protocol.

  • If the protocol is functioning, but has no active connections, the function will return 0.
  • If the protocol is functioning and has active connections, the function will return the number of active connections.
  • If the connection has failed, the function will return #ERR, and the GetErrorCode and GetErrorString functions can be used to determine the cause of the error. For more information, see GetErrorCode and GetErrorString.

The Event parameter should reference an Event function that is set to capture the Network Error event, or to the AcquireImage function in cell A0. For more information, see Event.

 

The Protocol parameter is used to define which protocol will be polled for a status update: 

  • 0 = EtherNet/IP
  • 1 = PROFINET
  • 2 = SLMP Scanner
  • 3 = Modbus TCP Server
  • 4 = CC Link
  • 5 = DeviceNet
  • 6 = POWERLINK
  • 8 = CC-Link IE Field Basic
  • 100 = The currently enabled industrial factory protocol
Note: CC Link and DeviceNet are not supported by this function. An “Argument Out of Range” error will be returned if these are selected.

GetFilename(FTP)

Returns the filename from an FTP data structure.
GetHexString(BitStream)

Returns the bits contained in a BitStream data structure as a hex string, with the standard "0x" prefix. The hex string is ordered so that the most significant nibble is first.

Note: If the number of bits is not a multiple of four, the zeroes are padded in the most significant position, which effectively groups the bits into nibbles, from right to left.
Bits With Padding Hex
1 1000 1
11 0011 3
111 0111 7
1111 1111 F
1 1111 0001 1111 1F
11 1111 0011 1111 3F
111 1111 0111 1111 7F
1111 1111 1111 1111 FF
GetNumBits(BitStream) Returns the total number of bits contained in a BitStream data structure.
GetNumWaveformsPending(Event)

Returns the total number of WriteWaveformPulseTrain or WriteWaveformClocked waveforms currently executing or queued for execution, or zero (0) if no waveform is currently being executed. Once this value equals zero (0), any new waveform will immediately execute; if this value is not zero (0), waveforms will be queued or dropped, depending on the applied settings and queue space. For more information, see WriteWaveformPulseTrain and WriteWaveformClocked.

Note: There is one single waveform queue, therefore this function does not use a WriteWaveformPulseTrain or WriteWaveformClocked function as an input. Instead, this function uses an event (such as a Button function or AcquireImage, for example) to update the function periodically.
GetRemoteAddress(Device) Returns the IP address of the device from which the UDP server received the last message. Device specifies a reference to a Device data structure returned by a UDPDevice function.
GetRemotePort(Device) Returns the Port Number of the device from which the UDP server received the last message. Device specifies a reference to a Device data structure returned by a UDPDevice function.

GetResult(Result, Index)

Returns an indexed value from a Result data structure.