beautypg.com

ProSoft Technology MVI56E-LDM User Manual

Page 92

background image

CIP API Functions

ControlLogix Platform ♦ "C" Programmable

Developer's Manual

Linux Application Development Module

Page 86 of 264

ProSoft Technology, Inc.

March 12, 2014

OCXcip_RegisterResetReqRtn

Syntax

int OCXcip_RegisterResetReqRtn( OCXHANDLE apihandle,
OCXCALLBACK (*resetrequest_proc)( ) );

Parameters

apihandle

apihandle

returned by previous call to OCXcip_Open

resetrequest_proc

pointer to reset request callback routine

Description
This function is used by an application to register a reset request callback
routine. Once registered, the backplane device driver will call

resetrequest_proc

if a module reset request is received.

apihandle

must be a valid handle returned from

OCXcip_Open

.

resetrequest_proc

must be a pointer to a reset request callback function.

If the application does not register a reset request handler, receipt of a module
reset request will result in a software reset (that is, reboot) of the module. The
application may register a reset request callback in order to perform an orderly
shutdown, reset special hardware, or to deny the reset request.

Return Value

OCX_SUCCESS

routine was registered successfully

OCX_ERR_NOACCESS

apihandle does not have access

Example

OCXCIPHANDLE apihandle;

// Register a reset request handler

OCXcip_RegisterResetReqRtn(apihandle, resetrequest_proc);

See Also
resetrequest_proc