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>
SysProcessCreate2 (FUN) ¶ FUNCTION SysProcessCreate2 : RTS_IEC_HANDLE <description>Function to create a process. NOTE: Is only available on systems with processes! This functions creates and eventually starts a new process for the specified application. The properties of the created process can be defined by appropriate flags.</description> <result><p>RESULT: Handle to the created process or RTS_INVALID_HANDLE if failed.</p></result> InOut: Scope Name Type Comment Return SysProcessCreate2 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> ulFlags UDINT <param name=”ulFlags” type=”IN”>A combination of the process flags SYSPROCESS_CREATEFLAG_XXX.</param> pResult POINTER TO RTS_IEC_RESULT <param name=”pResult” type=”OUT”>Pointer to runtime system error code (see CmpErrors.library)</param>
SysProcessExecuteCommand (FUN) ¶ FUNCTION SysProcessExecuteCommand : DINT <description>Function to start a system command. The command is operating system dependent!</description> <result><p>RESULT: Result of command after execution</p></result> InOut: Scope Name Type Comment Return SysProcessExecuteCommand DINT Input pszComand REFERENCE TO STRING <param name=”pszCommand” type=”IN”>Command line parameters to be transmitted to application at execution</param> pResult POINTER TO RTS_IEC_RESULT <param name=”pResult” type=”OUT”>Pointer to runtime system error code (see CmpErrors.library)</param>
SysProcessExecuteCommand2 (FUN) ¶ FUNCTION SysProcessExecuteCommand2 : DINT <description>Function to start a system command. The command is operating system dependent! Command will be executed, only if allowed (see settings for details). Output of the executed command will be filled into pszStdOut. </description> <result><p>RESULT: Number of bytes, read from the commands output.</p></result> InOut: Scope Name Type Comment Return SysProcessExecuteCommand2 DINT Input pszCommand REFERENCE TO STRING <param name=”pszCommand” type=”IN”>Command line parameters to be transmitted to application at execution</param> pszStdOut REFERENCE TO STRING <param name=”pszStdOut” type=”IN”>Buffer for StdOut string</param> udiStdOutLen UDINT <param name=”udiStdOutLen” type=”IN”>Buffersize for StdOut string buffer</param> pResult POINTER TO RTS_IEC_RESULT <param name=”pResult” type=”OUT”>Pointer to runtime system error code. ERR_PARAMETER: if pszCommand, pszStdOut or udiStdOutLen is null, ERR_NO_ACCESS_RIGHTS: if command is not allowed</param>
SysProcessFreeHandle (FUN) ¶ FUNCTION SysProcessFreeHandle : RTS_IEC_RESULT <description>Function to release the process handle that is returned by SysProcessCreate or SysProcessGetCurrentHandle.</description> <result><p>RESULT: Returns the runtime system error code (see CmpErrors.library).</p></result> InOut: Scope Name Type Comment Return SysProcessFreeHandle RTS_IEC_RESULT Input hProcess RTS_IEC_HANDLE <param name=”hProcess” type=”IN”>Handle of the process</param>
SysProcessGetCurrentHandle (FUN) ¶ FUNCTION SysProcessGetCurrentHandle : RTS_IEC_HANDLE <description>Function to get a handle to the current process</description> <result><p>RESULT: Returns the handle of the process actually running by the processor or RTS_INVALID_HANDLE if failed.</p></result> InOut: Scope Name Type Comment Return SysProcessGetCurrentHandle RTS_IEC_HANDLE Input pResult POINTER TO RTS_IEC_RESULT <param name=”pResult” type=”OUT”>Pointer to runtime system error code (see CmpErrors.library)</param>