beautypg.com

ProSoft Technology MVI56E-LDM User Manual

Page 200

background image

CIP API Functions

ControlLogix Platform ♦ "C" Programmable

Developer's Manual

Linux Application Development Module

Page 194 of 264

ProSoft Technology, Inc.

March 12, 2014

OCXcip_GetDisplay

Syntax

int OCXcip_GetDisplay (OCXHANDLE apihandle,

char * display_string);

Parameters

apihandle

handle returned by previous call to OCXcip_Open

display_string

Pointer to buffer to receive displayed string

Description

OCXcip_GetDisplay

allows and application to load 4 ASCII characters to the

alphanumeric display.

apihandle

must be a valid handle returned from

OCXcip_Open

.

display_string

must be a pointer to a buffer that is at least 5 bytes in length. On

successful return, this buffer will contain the 4-character display string and
terminating NULL character.

Return Value

OCX_SUCCESS

The display was read successfully

OCX_ERR_NOACCESS

apihandle

does not have access

Example

OCXHANDLE apiHandle;
char buf[5];

/* Display the time as HHMM */

OCXcip_SetDisplay (apiHandle, buf);