IApi.RegisterMailboxCallback method

Registers a function that the KINGSTAR Subsystem will call when a mailbox message comes in.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError RegisterMailboxCallback(
       MailboxCallback callback
)

Function RegisterMailboxCallback(
       callback As MailboxCallback
) As KsError

Parameters

callback

Type: MailboxCallback

Pointer to the function that will be called when a mailbox message arrives.

Return value

Type: KsError

A return code of a method.

Usable EtherCAT states

ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

Examples

N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace