Collaboration diagram for Read memory area:

Functions
MLPIRESULT	mlpiLogicReadMemoryAreaBool8 (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG bitOffset, BOOL8 data)

MLPIRESULT	mlpiLogicReadMemoryAreaChar (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, CHAR data)

MLPIRESULT	mlpiLogicReadMemoryAreaUchar (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, UCHAR data)

MLPIRESULT	mlpiLogicReadMemoryAreaShort (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, SHORT data)

MLPIRESULT	mlpiLogicReadMemoryAreaUshort (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, USHORT data)

MLPIRESULT	mlpiLogicReadMemoryAreaLong (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, LONG data)

MLPIRESULT	mlpiLogicReadMemoryAreaUlong (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, ULONG data)

MLPIRESULT	mlpiLogicReadMemoryAreaLlong (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, LLONG data)

MLPIRESULT	mlpiLogicReadMemoryAreaUllong (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, ULLONG data)

MLPIRESULT	mlpiLogicReadMemoryAreaFloat (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, FLOAT data)

MLPIRESULT	mlpiLogicReadMemoryAreaDouble (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, DOUBLE data)

MLPIRESULT	mlpiLogicReadMemoryAreaArrayChar (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, CHAR data, const ULONG numElements, ULONG *numElementsRet)

MLPIRESULT	mlpiLogicReadMemoryAreaArrayUchar (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, UCHAR data, const ULONG numElements, ULONG *numElementsRet)

MLPIRESULT	mlpiLogicReadMemoryAreaArrayShort (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, SHORT data, const ULONG numElements, ULONG *numElementsRet)

MLPIRESULT	mlpiLogicReadMemoryAreaArrayUshort (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, USHORT data, const ULONG numElements, ULONG *numElementsRet)

MLPIRESULT	mlpiLogicReadMemoryAreaArrayLong (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, LONG data, const ULONG numElements, ULONG *numElementsRet)

MLPIRESULT	mlpiLogicReadMemoryAreaArrayUlong (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, ULONG data, const ULONG numElements, ULONG *numElementsRet)

MLPIRESULT	mlpiLogicReadMemoryAreaArrayLlong (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, LLONG data, const ULONG numElements, ULONG *numElementsRet)

MLPIRESULT	mlpiLogicReadMemoryAreaArrayUllong (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, ULLONG data, const ULONG numElements, ULONG *numElementsRet)

MLPIRESULT	mlpiLogicReadMemoryAreaArrayFloat (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, FLOAT data, const ULONG numElements, ULONG *numElementsRet)

MLPIRESULT	mlpiLogicReadMemoryAreaArrayDouble (const MLPIHANDLE connection, const WCHAR16 application, const MlpiApplicationMemoryArea area, const ULONG byteOffset, DOUBLE data, const ULONG numElements, ULONG *numElementsRet)

Detailed Description

These functions read the following memory areas: "%Ix" (Input), "%Qx" (Output) and "%Mx" (Marker)

The table shows the PLC data types within the IEC61131 environment 'IndraLogic' and the corresponding data types within the C/C++ environment (e.g. 'Workbench OEM') of the MLPI. On reading from memory areas, on default, you use the functions below named after the MLPI data type like mlpiLogicReadMemoryAreaShort. If you include the header mlpiLogicHelper.h, you can also use the equivalent functions named after the IEC61131 data types like mlpiLogicReadMemoryAreaWord or like mlpiLogicReadMemoryAreaInt.

Note: Reading on outputs and writing on inputs is not supported yet.

Number of Bits	Data types of PLC	Data types of MLPI
8	BOOL	BOOL8
8	SINT	CHAR
16	INT	SHORT
32	DINT	LONG
64	LINT	LLONG
8	USINT	UCHAR
16	UINT	USHORT
32	UDINT	ULONG
64	ULINT	ULLONG
8	BYTE	UCHAR
16	WORD	USHORT
32	DWORD	ULONG
64	LWORD	ULLONG
32	REAL	FLOAT
64	LREAL	DOUBLE
8n	STRING	WCHAR16
16n	WSTRING	WCHAR16

Function Documentation

MLPIRESULT mlpiLogicReadMemoryAreaBool8	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	bitOffset,
		BOOL8 *	data
	)

This function reads a bit as a BOOL8 (BOOL8, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	bitOffset	Bit offset based on zero (e.g. IX0.0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IX1.5.
2 BOOL8 data = FALSE;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaBool8(connection, application, MLPI_MEMORY_AREA_INPUT, 13, &data);

MLPIRESULT mlpiLogicReadMemoryAreaChar	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		CHAR *	data
	)

This function reads the 8-bit signed data value (SINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IB42.
2 CHAR data = 0;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaChar(connection, application, MLPI_MEMORY_AREA_INPUT, 42, &data);

MLPIRESULT mlpiLogicReadMemoryAreaUchar	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		UCHAR *	data
	)

This function reads the 8-bit unsigned data value (BYTE, USINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IB42.
2 UCHAR data = 0;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaUchar(connection, application, MLPI_MEMORY_AREA_INPUT, 42, &data);

MLPIRESULT mlpiLogicReadMemoryAreaShort	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		SHORT *	data
	)

This function reads the 16-bit signed data value (INT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IW42.
2 SHORT data = 0;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaShort(connection, application, MLPI_MEMORY_AREA_INPUT, 42, &data);

MLPIRESULT mlpiLogicReadMemoryAreaUshort	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		USHORT *	data
	)

This function reads the 16-bit unsigned data value (WORD, UINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IW42.
2 USHORT data = 0;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaUshort(connection, application, MLPI_MEMORY_AREA_INPUT, 42, &data);

MLPIRESULT mlpiLogicReadMemoryAreaLong	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		LONG *	data
	)

This function reads the 32-bit signed data value (DINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %ID42.
2 LONG data = 0;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaLong(connection, application, MLPI_MEMORY_AREA_INPUT, 42, &data);

MLPIRESULT mlpiLogicReadMemoryAreaUlong	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		ULONG *	data
	)

This function reads the 32-bit unsigned data value (DWORD, UDINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %ID42.
2 ULONG data = 0;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaUlong(connection, application, MLPI_MEMORY_AREA_INPUT, 42, &data);

MLPIRESULT mlpiLogicReadMemoryAreaLlong	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		LLONG *	data
	)

This function reads the 64-bit signed data value (LINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IL42.
2 LLONG data = 0;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaLlong(connection, application, MLPI_MEMORY_AREA_INPUT, 42, &data);

MLPIRESULT mlpiLogicReadMemoryAreaUllong	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		ULLONG *	data
	)

This function reads the 64-bit unsigned data value (LWORD, ULINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IL42.
2 ULLONG data = 0;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaUllong(connection, application, MLPI_MEMORY_AREA_INPUT, 42, &data);

MLPIRESULT mlpiLogicReadMemoryAreaFloat	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		FLOAT *	data
	)

This function reads the 32-bit floating point data value (single precision, REAL, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %ID42.
2 FLOAT data = 0.0;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaFloat(connection, application, MLPI_MEMORY_AREA_INPUT, 42, &data);

MLPIRESULT mlpiLogicReadMemoryAreaDouble	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		DOUBLE *	data
	)

This function reads the 64-bit floating point data value (double precision, LREAL, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the value will be stored.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IL42.
2 DOUBLE data = 0.0;
3 WCHAR16 application = L"Application";
4 MLPIRESULT result = mlpiLogicReadMemoryAreaDouble(connection, application, MLPI_MEMORY_AREA_INPUT, 42, &data);

MLPIRESULT mlpiLogicReadMemoryAreaArrayChar	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		CHAR *	data,
		const ULONG	numElements,
		ULONG *	numElementsRet
	)

This function reads an array of 8-bit signed data values (SINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the values will be stored.
[in]	numElements	Number of CHAR elements in 'data' available to read.
[out]	numElementsRet	Number of elements used.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data values from the memory area %IB0 to %IB1.
2 CHAR data[2];
3 ULONG numElementsRet = 0;
4 WCHAR16 application = L"Application";
5 memset(data, 0, sizeof(data));
6 MLPIRESULT result = mlpiLogicReadMemoryAreaArrayChar(connection, application, MLPI_MEMORY_AREA_INPUT, 0, data, _countof(data), &numElementsRet);

MLPIRESULT mlpiLogicReadMemoryAreaArrayUchar	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		UCHAR *	data,
		const ULONG	numElements,
		ULONG *	numElementsRet
	)

This function reads an array of 8-bit unsigned data values (BYTE, USINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the values will be stored.
[in]	numElements	Number of UCHAR elements in data available to read.
[out]	numElementsRet	Number of elements used.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data values from the memory area %IB0 to %IB1.
2 UCHAR data[2];
3 ULONG numElementsRet = 0;
4 WCHAR16 application = L"Application";
5 memset(data, 0, sizeof(data));
6 MLPIRESULT result = mlpiLogicReadMemoryAreaArrayUchar(connection, application, MLPI_MEMORY_AREA_INPUT, 0, data, _countof(data), &numElementsRet);

MLPIRESULT mlpiLogicReadMemoryAreaArrayShort	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		SHORT *	data,
		const ULONG	numElements,
		ULONG *	numElementsRet
	)

This function reads an array of 16-bit signed data values (INT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the values will be stored.
[in]	numElements	Number of SHORT elements in data available to read.
[out]	numElementsRet	Number of elements used.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IW0 to %IW2.
2 SHORT data[2];
3 ULONG numElementsRet = 0;
4 WCHAR16 application = L"Application";
5 memset(data, 0, sizeof(data));
6 MLPIRESULT result = mlpiLogicReadMemoryAreaArrayShort(connection, application, MLPI_MEMORY_AREA_INPUT, 0, data, _countof(data), &numElementsRet);

MLPIRESULT mlpiLogicReadMemoryAreaArrayUshort	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		USHORT *	data,
		const ULONG	numElements,
		ULONG *	numElementsRet
	)

This function reads an array of 16-bit unsigned data values (WORD, UINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the values will be stored.
[in]	numElements	Number of USHORT elements in data available to read.
[out]	numElementsRet	Number of elements used.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IW0 to %IW2.
2 USHORT data[2];
3 ULONG numElementsRet = 0;
4 WCHAR16 application = L"Application";
5 memset(data, 0, sizeof(data));
6 MLPIRESULT result = mlpiLogicReadMemoryAreaArrayUshort(connection, application, MLPI_MEMORY_AREA_INPUT, 0, data, _countof(data), &numElementsRet);

MLPIRESULT mlpiLogicReadMemoryAreaArrayLong	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		LONG *	data,
		const ULONG	numElements,
		ULONG *	numElementsRet
	)

This function reads an array of 32-bit signed data values (DINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the values will be stored.
[in]	numElements	Number of LONG elements in data available to read.
[out]	numElementsRet	Number of elements used.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %ID0 to %ID4.
2 LONG data[2];
3 ULONG numElementsRet = 0;
4 WCHAR16 application = L"Application";
5 memset(data, 0, sizeof(data));
6 MLPIRESULT result = mlpiLogicReadMemoryAreaArrayLong(connection, application, MLPI_MEMORY_AREA_INPUT, 0, data, _countof(data), &numElementsRet);

MLPIRESULT mlpiLogicReadMemoryAreaArrayUlong	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		ULONG *	data,
		const ULONG	numElements,
		ULONG *	numElementsRet
	)

This function reads an array of 32-bit unsigned data values (DWORD, UDINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the values will be stored.
[in]	numElements	Number of ULONG elements in data available to read.
[out]	numElementsRet	Number of elements used.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %ID0 to %ID4.
2 ULONG data[2];
3 ULONG numElementsRet = 0;
4 WCHAR16 application = L"Application";
5 memset(data, 0, sizeof(data));
6 MLPIRESULT result = mlpiLogicReadMemoryAreaArrayUlong(connection, application, MLPI_MEMORY_AREA_INPUT, 0, data, _countof(data), &numElementsRet);

MLPIRESULT mlpiLogicReadMemoryAreaArrayLlong	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		LLONG *	data,
		const ULONG	numElements,
		ULONG *	numElementsRet
	)

This function reads an array of 64-bit signed data values (LINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the values will be stored.
[in]	numElements	Number of LLONG elements in data available to read.
[out]	numElementsRet	Number of elements used.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IL0 to %IL8.
2 LLONG data[2];
3 ULONG numElementsRet = 0;
4 WCHAR16 application = L"Application";
5 memset(data, 0, sizeof(data));
6 MLPIRESULT result = mlpiLogicReadMemoryAreaArrayLlong(connection, application, MLPI_MEMORY_AREA_INPUT, 0, data, _countof(data), &numElementsRet);

MLPIRESULT mlpiLogicReadMemoryAreaArrayUllong	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		ULLONG *	data,
		const ULONG	numElements,
		ULONG *	numElementsRet
	)

This function reads an array of 64-bit unsigned data values (LWORD, ULINT, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the values will be stored.
[in]	numElements	Number of ULLONG elements in data available to read.
[out]	numElementsRet	Number of elements used.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IL0 to %IL8.
2 ULLONG data[2];
3 ULONG numElementsRet = 0;
4 WCHAR16 application = L"Application";
5 memset(data, 0, sizeof(data));
6 MLPIRESULT result = mlpiLogicReadMemoryAreaArrayUllong(connection, application, MLPI_MEMORY_AREA_INPUT, 0, data, _countof(data), &numElementsRet);

MLPIRESULT mlpiLogicReadMemoryAreaArrayFloat	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		FLOAT *	data,
		const ULONG	numElements,
		ULONG *	numElementsRet
	)

This function reads an array of 32-bit floating point data values (single precision, REAL, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the values will be stored.
[in]	numElements	Number of FLOAT elements in data available to read.
[out]	numElementsRet	Number of elements used.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %ID0 to %ID4.
2 FLOAT data[2];
3 ULONG numElementsRet = 0;
4 WCHAR16 application = L"Application";
5 memset(data, 0, sizeof(data));
6 MLPIRESULT result = mlpiLogicReadMemoryAreaArrayFloat(connection, application, MLPI_MEMORY_AREA_INPUT, 0, data, _countof(data), &numElementsRet);

MLPIRESULT mlpiLogicReadMemoryAreaArrayDouble	(	const MLPIHANDLE	connection,
		const WCHAR16 *	application,
		const MlpiApplicationMemoryArea	area,
		const ULONG	byteOffset,
		DOUBLE *	data,
		const ULONG	numElements,
		ULONG *	numElementsRet
	)

This function reads an array of 64-bit floating point data values (double precision, LREAL, MlpiLogicType) from the memory area (MlpiApplicationMemoryArea).

Parameters

[in]	connection	Handle for multiple connections.
[in]	application	Name of application.
[in]	area	Memory area of access (MlpiApplicationMemoryArea).
[in]	byteOffset	Byte offset based on zero (e.g. IB0).
[out]	data	Pointer to variable where the values will be stored.
[in]	numElements	Number of DOUBLE elements in data available to read.
[out]	numElementsRet	Number of elements used.

Returns: Return value indicating success (>=0) or error (<0).

Example:: 1 // Read the data value from the memory area %IL0 to %IL8.
2 DOUBLE data[2];
3 ULONG numElementsRet = 0;
4 WCHAR16 application = L"Application";
5 memset(data, 0, sizeof(data));
6 MLPIRESULT result = mlpiLogicReadMemoryAreaArrayDouble(connection, application, MLPI_MEMORY_AREA_INPUT, 0, data, _countof(data), &numElementsRet);

Functions

Detailed Description

Function Documentation