Click or drag to resize

MemoryAccessReadAsync Method (Boolean, Buffer, MemoryAddress, AccessParameters, IOErrorHandler, Object, Signal)

Block read data from the peer.

Namespace:  Demo3D.PLC.Comms.Memory
Assembly:  PLC (in PLC.dll) Version: 15.0.2.11458
Syntax
C#
Copy
public Task<bool> ReadAsync(
	bool sync,
	Buffer buffer,
	MemoryAddress? address = null,
	AccessParameters? accessParams = null,
	IOErrorHandler? errorHandler = null,
	Object? userState = null,
	Signal? signal = null
)

Parameters

sync
Type: SystemBoolean
If true, the Task returned is guaranteed to be complete.
buffer
Type: Demo3D.IOBuffer
The buffer to read data into.
address (Optional)
Type: Demo3D.PLC.CommsMemoryAddress
The address to read (or null).
accessParams (Optional)
Type: Demo3D.PLC.CommsAccessParameters
Access parameters for this read request (or null to use the access parameters provided to GetAddress(IAddress, AccessParameters, Object)).
errorHandler (Optional)
Type: Demo3D.PLC.CommsIOErrorHandler
An error handler to call if an IO error is detected (or null).
userState (Optional)
Type: SystemObject
An object to pass to errorHandler (or null).
signal (Optional)
Type: Demo3D.IOSignal
A trackable object.

Return Value

Type: TaskBoolean
True if the read request succeeded.
See Also