SysSock2SendTo (FUN) ¶ FUNCTION SysSock2SendTo : __XINT Send a message over a connectionless socket (UDP). InOut: Scope Name Type Comment Return SysSock2SendTo __XINT Number of bytes sent. Input hSocket RTS_IEC_HANDLE Handle to the socket pbyBuffer POINTER TO BYTE Buffer with send data diBufferSize __XINT Length of data to send. If diBufferSize = 0 ERR_PARAMETER is returned diFlags DINT The flags parameter can be used to influence the behavior of the function beyond the options specified for the associated socket. The semantics of this function are determined by the socket options and the flags parameter. The latter is constructed by using the bitwise OR operator with any of the SOCKET_MSG values. pSockAddr POINTER TO SOCKADDRESS Socket address and port to sent data to diSockAddrSize DINT Size of socket address structure pResult POINTER TO RTS_IEC_RESULT Pointer to runtime system error code (see CmpErrors.library)
SysSock2SetOption (FUN) ¶ FUNCTION SysSock2SetOption : RTS_IEC_RESULT Set options of a specified socket. InOut: Scope Name Type Comment Return SysSock2SetOption RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input hSocket RTS_IEC_HANDLE Handle to the socket diLevel DINT Level of the socket diOption DINT Socket option command pdiOptionValue POINTER TO BYTE Pointer to the option value diOptionLen DINT Lenght of option value
SysSock2Shutdown (FUN) ¶ FUNCTION SysSock2Shutdown : RTS_IEC_RESULT Shutdown a socket. InOut: Scope Name Type Comment Return SysSock2Shutdown RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input hSocket RTS_IEC_HANDLE Handle to the socket diHow DINT Specifies, which operations are no longer be allowed. See shutdown flags.
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 02.03.2023, 11:07:28 companyName string 3S-Smart Software Solutions GmbH libraryFile SysSocket2 Implementation.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile SysSocket2 Implementation.clean.json version version 2.0.0.0 ProjectInformation IsEndUserLibrary bool False Released True LastModificationDateTime date 02.03.2023, 11:07:26 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace Description See: Description DocFormat reStructuredText Placeholder SysSocket2 Implementation Project SysSocket2 Implementation Title SysSocket2 Implementation Version version 3.5.19.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. SysSocket Interfaces ¶ Library Identification ¶ Name: SysSocket Interfaces Version: newest Company: System Namespace: SysSocket_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSocket Interfaces, * (System) SysSocket2 Interfaces ¶ Library Identification ¶ Name: SysSocket2 Interfaces Version: newest Company: System Namespace: SysSocket2_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSocket2 Interfaces, * (System) 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)
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>