SysPipeWindowsClose (FUN) ¶ FUNCTION SysPipeWindowsClose : RTS_IEC_RESULT Close the handle to the pipe file Implementation internal: If overlapped, then also close the event for overlapped mode. InOut: Scope Name Type Comment Return SysPipeWindowsClose RTS_IEC_RESULT Input hPipe RTS_IEC_HANDLE Handle to a SysPipeWindows instance

SysPipeWindowsOpen (FUN) ¶ FUNCTION SysPipeWindowsOpen : RTS_IEC_HANDLE Open a named pipe Implementation internal: If overlapped, then also create event for overlapped mode. The function returns a handle to a SysPipeWindows instance that can be used to access the named pipe. If the CreateNamedPipe function was not successfully called on the server prior to this operation, a pipe will not exist and SysPipeWindowsOpen will fail with ERR_NO_OBJECT (0x10) in pResult. Implementation internal: A SysPipeWindows instance holds a handle to the pipe file an instance of the OVERLAPPED structure with a handle to an event for overlapped mode InOut: Scope Name Type Comment Return SysPipeWindowsOpen RTS_IEC_HANDLE Input pszName STRING Pipe name dwAccessMode DWORD Access mode - SysPipe_Interfaces.SYSPIPE_OPEN_READ - SysPipe_Interfaces.SYSPIPE_OPEN_WRITE - SysPipe_Interfaces.SYSPIPE_OPEN_READ OR SysPipe_Interfaces.SYSPIPE_OPEN_WRITE xOverlapped BOOL TRUE: Overlapped mode (asynchronous). FALSE: Synchronous mode. See: https://docs.microsoft.com/en-us/windows/win32/ipc/named-pipe-open-modes pResult POINTER TO RTS_IEC_RESULT Error code: ERR_OK: Success ERR_PARAMETER: If one of the parameters is invalid (szName = NULL). ERR_END_OF_OBJECT: Pipe doesn’t exist because the CreateNamedPipe function was not successfully called on the server prior to this operation. ERR_DUPLICATE: Named pipe object already exists. A valid handle to this object is returned here. ERR_OUT_OF_LIMITS: There is at least one active pipe instance but there are no available listener pipes on the server, which means all pipe instances are currently connected. ERR_FAILED: Any other error (see log)

SysPipeWindowsPeek (FUN) ¶ FUNCTION SysPipeWindowsPeek : RTS_IEC_RESULT Read without removing the contents of a pipe. Copies data from a named or anonymous pipe into a buffer without removing it from the pipe. It also returns information about data in the pipe. InOut: Scope Name Type Comment Return SysPipeWindowsPeek RTS_IEC_RESULT Error code: ERR_OK: Success ERR_NET_NOTCONNECTED: ERROR_PIPE_NOT_CONNECTED ERR_END_OF_OBJECT: ERROR_BROKEN_PIPE Input hPipe RTS_IEC_HANDLE Handle to a SysPipeWindows instance pbyBuffer POINTER TO BYTE A pointer to a buffer that receives data read from the pipe. This parameter can be NULL if no data is to be read. uxSize __UXINT The size of the buffer specified by the lpBuffer parameter, in bytes. This parameter is ignored if lpBuffer is NULL. puxBytesRead POINTER TO __UXINT A pointer to a variable that receives the number of bytes read from the pipe. This parameter can be NULL if no data is to be read puxTotalBytesAvail POINTER TO __UXINT A pointer to a variable that receives the total number of bytes available to be read from the pipe. This parameter can be NULL if no data is to be read. puxBytesLeftThisMessage POINTER TO __UXINT A pointer to a variable that receives the number OF bytes remaining in this message. This parameter will be zero for byte-type named pipes or for anonymous pipes. This parameter can be NULL if no data is to be read.

SysPipeWindowsRead (FUN) ¶ FUNCTION SysPipeWindowsRead : RTS_IEC_RESULT This function can be used to read a defined number of bytes from a named pipe. InOut: Scope Name Type Comment Return SysPipeWindowsRead RTS_IEC_RESULT Error code: ERR_OK: Success ERR_PARAMETER: Any of the following hPipe = NULL hPipe = RTS_INVALID_HANDLE pbyBuffer = NULL (dwTimeoutMs <> 0) AND (pipe was not opened with parameter xOverlapped = TRUE) ERR_END_OF_OBJECT: Reading the pipe resulted in ERROR_BROKEN_PIPE ERR_TIMEOUT: dwTimeoutMs has been nonzero and the specified timeout interval has elapsed. ERR_NET_NOTCONNECTED: ERROR_PIPE_NOT_CONNECTED. ERR_NOTHING_TO_DO: ERROR_NO_DATA. ERR_FAILED: Any other error (see log) Input hPipe RTS_IEC_HANDLE Handle to a SysPipeWindows instance pbyBuffer POINTER TO BYTE Buffer uxSize __UXINT Number of bytes to read puxBytesRead POINTER TO __UXINT Number of bytes read from the named pipe dwTimeoutMs DWORD Timeout in milliseconds for overlapped reading. Set to 0 for synchronous not overlapped reading. Has to be 0 if the pipe was not opened with parameter xOverlapped = TRUE.

SysPipeWindowsSetHandleState (FUN) ¶ FUNCTION SysPipeWindowsSetHandleState : RTS_IEC_RESULT Set the read mode and the blocking mode InOut: Scope Name Type Comment Return SysPipeWindowsSetHandleState RTS_IEC_RESULT Input hPipe RTS_IEC_HANDLE Handle to a SysPipeWindows instance xMessageReadMode BOOL Message read mode (else: byte read mode) xWait BOOL Blocking wait mode (else: non-blocking wait mode)

SysPipeWindowsWrite (FUN) ¶ FUNCTION SysPipeWindowsWrite : RTS_IEC_RESULT This function can be used to write a defined number of bytes to a named pipe area. InOut: Scope Name Type Comment Return SysPipeWindowsWrite RTS_IEC_RESULT Error code: ERR_OK: Success ERR_PARAMETER: Any of the following hPipe = NULL hPipe = RTS_INVALID_HANDLE pbyBuffer = NULL (dwTimeoutMs <> 0) AND (pipe was not opened with parameter xOverlapped = TRUE) ERR_END_OF_OBJECT: Writing the pipe resulted in ERROR_BROKEN_PIPE ERR_TIMEOUT: dwTimeoutMs has been nonzero and the specified timeout interval has elapsed. ERR_NET_NOTCONNECTED: ERROR_PIPE_NOT_CONNECTED. ERR_FAILED: Any other error (see log) Input hPipe RTS_IEC_HANDLE Handle to a SysPipeWindows instance pbyBuffer POINTER TO BYTE Buffer uxBytesToWrite __UXINT Number of bytes to write puxBytesWritten POINTER TO __UXINT Number of bytes written to the named pipe dwTimeoutMs DWORD Timeout in milliseconds for overlapped writing. Set to 0 for synchronous not overlapped writing. Has to be 0 if the pipe was not opened with parameter xOverlapped = TRUE.

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

Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)

SysProcess Implementation Library Documentation ¶ Company System Title SysProcess Implementation Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Placeholder SysProcess Implementation Description 1 ¶ This library allows to manage the processes on the target system provided the target system is working with single processes and admits their handling. Contents: ¶ SysProcessCreate (Function) SysProcessCreate2 (Function) SysProcessExecuteCommand (Function) SysProcessExecuteCommand2 (Function) SysProcessFreeHandle (Function) SysProcessGetCurrentHandle (Function) SysProcessGetOSId (Function) SysProcessGetPriority (Function) SysProcessGetState (Function) SysProcessResume (Function) SysProcessSetPriority (Function) SysProcessTerminate (Function) Indices and tables ¶ 1 Based on SysProcess Implementation.library, last modified 20.04.2021, 16:06:17. LibDoc 4.4.0.0-b.27 The content file SysProcess Implementation.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 16:06:18.

SysProcessCreate (FUN) ¶ FUNCTION SysProcessCreate : RTS_IEC_HANDLE <description>Function to create a process. NOTE: Is only available on systems with processes! This function starts the specified application as new process, optionally either in the fore- or in the background. </description> <result><p>RESULT: Handle to the created process or RTS_INVALID_HANDLE if failed.</p></result> InOut: Scope Name Type Comment Return SysProcessCreate RTS_IEC_HANDLE Input pszApplication REFERENCE TO STRING <param name=”pszApplication” type=”IN”>Name of application to start as a separate process</param> pszCommandLine REFERENCE TO STRING <param name=”pszCommandLine” type=”IN”>String with the command line</param> ulHide UDINT <param name=”ulHide” type=”IN”>The application runs in the background for ulHide=1, else in the foreground.</param> pResult POINTER TO RTS_IEC_RESULT <param name=”pResult” type=”OUT”>Pointer to runtime system error code (see CmpErrors.library)</param>