PlcOpcPipeClient.c File Reference

PlcOpcPipeClient.Dia. More...

Macros
#define	DEBUG_WMK_ERR
#define	CALLMODE_DATA_TO_DEVICE   1
#define	CALLMODE_DATA_FROM_DEVICE   2
#define	CALLMODE_SYNCDATA_FROM_DEVICE   3
#define	CALLMODE_BROWSENAMEDITEMS   4
#define	CALLMODE_CREATEITEM   5
#define	CALLMODE_ACTIVATEITEM   6
#define	CALLMODE_DEACTIVATEITEM   7
#define	CALLMODE_REFRESHITEM   8
#define	CALLMODE_HISTORY_DATA_FROM_DEVICE   9

Functions
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopCreateItemData (OPCPIPE_INTERNALS *t, W_UINT32 count, INTERNAL_CREATE_ITEM_DATA *ptr, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopDeleteItemData (OPCPIPE_INTERNALS *t, W_UINT32 count, INTERNAL_HANDLE_ITEM_DATA *ptr, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopActivateItemData (OPCPIPE_INTERNALS *t, W_UINT32 count, INTERNAL_HANDLE_ITEM_DATA *ptr, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopDeactivateItemData (OPCPIPE_INTERNALS *t, W_UINT32 count, INTERNAL_HANDLE_ITEM_DATA *ptr, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopCyclicReadData (OPCPIPE_INTERNALS *t, W_UINT32 count, INTERNAL_RW_ITEM_DATA *ptr, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopSyncReadData (OPCPIPE_INTERNALS *t, WMK_OPCPIPE_HANDLE readHandle, W_UINT32 count, INTERNAL_RW_ITEM_DATA *ptr, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopWriteComplete (OPCPIPE_INTERNALS *t, WMK_OPCPIPE_HANDLE writeHandle, W_UINT32 count, INTERNAL_RW_ITEM_DATA *ptr, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopHistoryReadData (OPCPIPE_INTERNALS *t, WMK_OPCPIPE_HANDLE readHandle, INTERNAL_HISTORY_ITEM_DATA *ptr, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopEventHistoryReadData (OPCPIPE_INTERNALS *t, WMK_OPCPIPE_HANDLE readHandle, INTERNAL_HISTORY_EVENT_DATA *ptr, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopBrowseData (OPCPIPE_INTERNALS *t, WMK_OPCPIPE_HANDLE browseHandle, W_UINT32 dataLen, void *data, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopDiagnosticsData (OPCPIPE_INTERNALS *t, WMK_OPCPIPE_HANDLE diagHandle, W_UINT32 dataLen, void *data, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopError (OPCPIPE_INTERNALS *t, WMK_OPCPIPE_HANDLE netItemHandle, WMK_OPCPIPE_HANDLE requestHandle, W_UINT32 error, int lr, W_UINT16 opcode, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopRpcData (OPCPIPE_INTERNALS *t, WMK_OPCPIPE_HANDLE callHandle, W_UINT32 errorCode, W_UINT32 resultCount, RPC_PARAMETER *results, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopCreateEventData (OPCPIPE_INTERNALS *t, W_UINT32 count, EVENT_REQUEST *ptr, int *perr)
EXTERN_C OPCPIPE_INTERNALS *WENTRY_C	OpcPipeClientLoopEventData (OPCPIPE_INTERNALS *t, W_UINT32 count, EVENT_RESULT *ptr, int *perr)
EXTERN_C int WENTRY_C	WmkProtBasePresetInit (CORE_PRESET_VALUES *bp)
EXTERN_C int WENTRY_C	WmkProtClientInit (PLC_OPCPIPE_CONFIRMS *confirm)
EXTERN_C int WENTRY_C	WmkProtClientInitEx (PLC_OPCPIPE_CONFIRMS_EX *confirm)
EXTERN_C int WENTRY_C	WmkProtClientTerminate (void)
EXTERN_C int WENTRY_C	WmkProtClientValidateLibVersions ()
EXTERN_C int WENTRY_C	WmkProtClientConnection (IP_CONNECT_PARAMS *ip, W_UINT8 *adapter, W_UINT32 *rethandle, const char *pwd, W_UINT32 options)
EXTERN_C int WENTRY_C	WmkProtOpcClientConnection (UINT32 *rethandle, OPC_DA_PARAMS *da)
EXTERN_C int WENTRY_C	WmkProtOpcUaClientConnection (PLC_OPCUA_CONNECTION_PARAMS *cr, UINT32 *rethandle)
EXTERN_C int WENTRY_C	WmkProtMqttClientConnection (PLC_MQTT_CONNECTION_PARAMS *cr, UINT32 *rethandle)
EXTERN_C int WENTRY_C	WmkProtKNXClientConnection (PLC_KNX_CONNECTION_PARAMS *cr, UINT32 *rethandle)
EXTERN_C int WENTRY_C	WmkProtIEC104ClientConnection (PLC_IEC104_CONNECTION_PARAMS *cr, UINT32 *rethandle)
EXTERN_C int WENTRY_C	WmkProtClientStopConnection (W_UINT32 handle, int disableConfirms)
	Stops one client connection. There is no housekeeping on this function, only the connection is closed and internal memory is freed. More...
EXTERN_C int WENTRY_C	WmkProtClientSetConnectionName (W_UINT32 handle, const char *connectionName)
	sets the connection name, used to separate structure names for different connections.
EXTERN_C int WENTRY_C	WmkProtCreateItemEx (W_UINT32 handle, W_UINT32 itemsCount, WMK_PROT_CREATE_ITEM_DATA_EX *items)
EXTERN_C int WENTRY_C	WmkProtCreateItem (W_UINT32 handle, W_UINT32 itemsCount, WMK_PROT_CREATE_ITEM_DATA *items)
EXTERN_C int WENTRY_C	WmkProtActivateItem (W_UINT32 handle, W_UINT32 itemsCount, WMK_PROT_HANDLE_ITEM_DATA *pipeItemHandles)
EXTERN_C int WENTRY_C	WmkProtDeactivateItem (W_UINT32 handle, W_UINT32 itemsCount, WMK_PROT_HANDLE_ITEM_DATA *pipeItemHandles)
EXTERN_C int WENTRY_C	WmkProtDeleteItem (W_UINT32 handle, W_UINT32 itemsCount, WMK_PROT_HANDLE_ITEM_DATA *items)
EXTERN_C int WENTRY_C	WmkProtWriteItem (W_UINT32 handle, WMK_OPCPIPE_HANDLE writeHandle, W_UINT32 itemsCount, WMK_PROT_RW_ITEM_DATA *items)
EXTERN_C int WENTRY_C	WmkProtRefreshItem (W_UINT32 handle, WMK_OPCPIPE_HANDLE readHandle, W_UINT32 itemsCount, WMK_PROT_RW_ITEM_DATA *items)
EXTERN_C int WENTRY_C	WmkProtSyncReadItem (W_UINT32 handle, WMK_OPCPIPE_HANDLE readHandle, W_UINT32 itemsCount, WMK_PROT_RW_ITEM_DATA *items)
EXTERN_C int WENTRY_C	WmkProtHistoryReadItem (W_UINT32 handle, WMK_OPCPIPE_HANDLE readHandle, WMK_PROT_HISTORY_ITEM_DATA *items)
EXTERN_C int WENTRY_C	WmkProtHistoryReadEvent (W_UINT32 handle, WMK_OPCPIPE_HANDLE readHandle, WMK_PROT_HISTORY_EVENT_DATA *event)
EXTERN_C int WENTRY_C	WmkProtStopWriteItems (W_UINT32 handle, WMK_OPCPIPE_HANDLE writeHandle)
EXTERN_C int WENTRY_C	WmkProtStopSyncReadItems (W_UINT32 handle, WMK_OPCPIPE_HANDLE readHandle)
EXTERN_C int WENTRY_C	WmkProtWaitConfirm (W_UINT32 handle, WMK_CONFIRM confirm)
	Registers the wait ready confirm. The confirm will be called each time the OPCpipe connection changes from the wait state to the normal state. This happens if a call returns with TU_STATUS_WAIT and now the next call can be made. More...
EXTERN_C int WENTRY_C	WmkProtConnStatus (OPCPIPE_STATUS *status)
	Checks the actual status of the OPCpipe connection. The element Handle need to be initialized with the net handle before call. More...
EXTERN_C int WENTRY_C	WmkProtChangeConnStatus (OPCPIPE_STATUS *status)
	Changes properties of the OPCpipe connection. The element Handle need to be initialized with the net handle before call. Flags and FlagsMask are set according to the properties to be changed. More...
EXTERN_C int WENTRY_C	WmkProtDiagnostics (W_UINT32 handle, WMK_OPCPIPE_HANDLE diagHandle, WMK_OPCPIPE_HANDLE *pipeTopicHandle, W_UINT32 no)
EXTERN_C int WENTRY_C	WmkProtBrowse (W_UINT32 handle, WMK_OPCPIPE_HANDLE browseHandle, W_UINT32 browseOpcode, W_UINT32 startOffset, const char *path, OPCPIPE_BROWSE_REQUEST_PARAMS *browseParams, W_UINT16 typ, W_UINT8 browseFlags)
EXTERN_C int WENTRY_C	WmkProtStopBrowse (W_UINT32 handle, WMK_OPCPIPE_HANDLE browseHandle, W_UINT32 browseOpcode)
EXTERN_C int WENTRY_C	WmkProtDiagTopicName (W_UINT32 handle, WMK_OPCPIPE_HANDLE pipeTopicHandle, char *topicName, W_UINT16 namelen)
	This enables querying the topic name from the return values of the diagnostics calls. More...
EXTERN_C int WENTRY_C	WmkProtDiagItemName (W_UINT32 handle, WMK_OPCPIPE_HANDLE pipeItemHandle, char *itemName, W_UINT16 namelen)
	This enables querying the item name from the return values of the diagnostics calls. More...
EXTERN_C int WENTRY_C	WmkProtRpcCall (W_UINT32 handle, W_UINT32 callHandle, W_UINT32 rpcId, const char *name, W_UINT32 paramCount, RPC_PARAMETER *params)
EXTERN_C int WENTRY_C	WmkProtMonitorEvents (W_UINT32 handle, W_UINT32 eventCount, EVENT_REQUEST *events)
EXTERN_C int WENTRY_C	WmkProtModifyMonitorEvents (W_UINT32 handle, W_UINT32 eventCount, EVENT_REQUEST *events)
EXTERN_C int WENTRY_C	WmkProtDeleteEvents (W_UINT32 handle, W_UINT32 eventCount, W_UINT32 *eventHandles)
EXTERN_C int WENTRY_C	WmkProtQueryItemInformation (W_UINT32 handle, WMK_OPCPIPE_HANDLE pipeItemHandle, WMK_OPCPIPE_ITEM_INFO *itemInfo)
EXTERN_C int WENTRY_C	WmkProtRegisterServer (W_UINT32 handle, W_UINT16 port, int isOnline)
	registers an opc ua server with a discovery server More...
EXTERN_C int WENTRY_C	WmkProtKNXItemSyntaxParse (const char *itemSyntax, PLC_BROWSE_RESPONSE *address, W_UINT32 addressMemlen)
EXTERN_C int WENTRY_C	WmkProtIEC104ItemSyntaxParse (W_UINT32 handle, const char *itemSyntax, PLC_BROWSE_RESPONSE *address, W_UINT32 addressMemlen)
EXTERN_C int WENTRY_C	WmkProtMqttItemSyntaxParse (W_UINT32 handle, const char *itemSyntax, PLC_BROWSE_RESPONSE *address, W_UINT32 addressMemlen)

Variables
W_UINT32	OpcUaStartDelay

Detailed Description

PlcOpcPipeClient.Dia.

PlcOpcPipeClient.Dia

Author

MN

Version

5986

Date

Fri Mar 13 10:56:13 2026 !

Function Documentation

WmkProtClientConnection()

EXTERN_C int WENTRY_C WmkProtClientConnection	(	IP_CONNECT_PARAMS *	ip,
		W_UINT8 *	adapter,
		W_UINT32 *	rethandle,
		const char *	pwd,
		W_UINT32	options
	)

Starts one OpcPipe client connection. The client must be initialized before.

Returns

error values

See also

WmkProtClientStopConnection

Parameters

[in]	ip	IP connect params for the connection
[in]	adapter	0 or the adapter id to use
[out]	rethandle	Address to the returned client connection handle . The handle is valid if no error returns.
[in]	pwd	The password string. Internally this is handled in MD5 manner. The password is case sensitive, it can contain all letters and is null terminated ("C" string).
[in]	options	Bitwise options. values for the options and OPCPIPE_PARAMS::Options in starting a connection, bitwise