AsyncBaseClass (FB) ¶ FUNCTION_BLOCK AsyncBaseClass Function block to handle the asynchronous job. Methods: AsyncRemoveJob AsyncSetJobParams Structure: AsyncRemoveJob (Method) AsyncSetJobParams (Method)

AsyncBaseClass.AsyncRemoveJob (METH) ¶ METHOD AsyncRemoveJob : RTS_IEC_RESULT Method to remove a job. InOut: Scope Name Type Comment Return AsyncRemoveJob RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_OK: Job has been successfully removed ERR_FAILED: Job cannot be removed because it has been started ERR_PARAMETER: hJob is invalid ERR_PENDING: Job cannot be removed because it is active Input hJob RTS_IEC_HANDLE Handle to the job object.

AsyncBaseClass.AsyncSetJobParams (METH) ¶ METHOD AsyncSetJobParams : RTS_IEC_RESULT Method to set the job parameters. See AsyncAdd for documentation of the parameters. InOut: Scope Name Type Return AsyncSetJobParams RTS_IEC_RESULT Input ulAsyncJobType UDINT ulTimeout UDINT pAsyncJobParams POINTER TO ASYNCJOB_PARAM

AsyncGetJobReturnValue (FUN) ¶ FUNCTION AsyncGetJobReturnValue : RTS_IEC_RESULT Do not use. Parameter pulState will be updated by CmpAsyncMgr automatically. InOut: Scope Name Type Return AsyncGetJobReturnValue RTS_IEC_RESULT Input hJob RTS_IEC_HANDLE pulReturnVal POINTER TO UDINT

AsyncKill (FUN) ¶ FUNCTION AsyncKill : RTS_IEC_RESULT Kill active job. InOut: Scope Name Type Comment Return AsyncKill RTS_IEC_RESULT Input hJob RTS_IEC_HANDLE Handle of job, returned by AsyncAdd

AsyncRemove (FUN) ¶ FUNCTION AsyncRemove : RTS_IEC_RESULT Remove a job. InOut: Scope Name Type Comment Return AsyncRemove RTS_IEC_RESULT Returns the runtime system error code (see CmpErrors.library): ERR_OK: Job has been successfully removed ERR_FAILED: Job cannot be removed because it has been started ERR_PARAMETER: hJob is invalid ERR_PENDING: Job cannot be removed because it is active Input hJob RTS_IEC_HANDLE Handle of job, returned by AsyncAdd

AsyncRemoveAll (FUN) ¶ FUNCTION AsyncRemoveAll : RTS_IEC_RESULT On shutdown or reset, or before download, call AsyncRemoveAll() to removed all registered asynchronous jobs. InOut: Scope Name Type Comment Return AsyncRemoveAll RTS_IEC_RESULT Always returns ERR_OK

GVL (GVL) ¶ Global defines for CmpAsyncMgr InOut: Scope Name Type Initial Comment Constant ASYNCJOB_TASK UDINT 0 Parameter ulType of AsyncAdd ASYNCJOB_EVENT UDINT 1 Parameter ulType of AsyncAdd ASYNCJOB_HOOK UDINT 2 Parameter ulType of AsyncAdd ASYNCSTATE_INVALID UDINT 16#FFFFFFFF State of an async job ASYNCSTATE_PENDING UDINT 0 State of an async job ASYNCSTATE_ACTIVE UDINT 1 State of an async job ASYNCSTATE_READY UDINT 2 State of an async job ASYNCSTATE_ERROR UDINT 3 State of an async job ASYNCSTATE_TIMEOUT UDINT 4 State of an async job ASYNC_TIMEOUT_INFINITE UDINT 0 Parameter ulTimeout of AsyncAdd ASYNC_IS_IEC UDINT 1 Parameter ulIecFunc of AsyncAdd ASYNC_ISNOT_IEC UDINT 0 Parameter ulIecFunc of AsyncAdd CH_COMM_CYCLE UDINT 20 Hooks

GVL_2 (GVL) ¶ Version define for CmpAsyncMgr InOut: Scope Name Type Initial Constant CMPASYNCMGR_VERSION_3_5_6_0 BOOL TRUE

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:33:39 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpAsyncMgr.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpAsyncMgr.clean.json version version 2.0.0.0 ProjectInformation LinkInSimulation bool True Released True LastModificationDateTime date 20.04.2021, 15:33:39 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description DocFormat reStructuredText Placeholder CmpAsyncMgr Project CmpAsyncMgr Title CmpAsyncMgr Version version 3.5.17.0