Core Function DLLStructGetData - Revision history

UberFoX: 1 revision

2015-06-14T12:38:43Z

1 revision

← Older revision

Revision as of 12:38, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:40:38Z

1 revision

← Older revision

Revision as of 21:40, 11 August 2014

UberFoX: /* Return Value */

2013-08-26T00:30:56Z

Return Value

← Older revision		Revision as of 00:30, 26 August 2013
Line 25:		Line 25:
	Success: Data in the element of the struct. -- NOTE - The return value is exactly what you asked for ie your SV will become an Int32 etc.		Success: Data in the element of the struct. -- NOTE - The return value is exactly what you asked for ie your SV will become an Int32 etc.

−	Failure: 0.	+	Failure: null.

	=== Remarks ===		=== Remarks ===

UberFoX at 00:46, 9 December 2011

2011-12-09T00:46:54Z

← Older revision		Revision as of 00:46, 9 December 2011
Line 23:		Line 23:
	=== Return Value ===		=== Return Value ===

−	Success: Data in the element of the struct.	+	Success: Data in the element of the struct. -- NOTE - The return value is exactly what you asked for ie your SV will become an Int32 etc.

	Failure: 0.		Failure: 0.

UberFoX at 17:57, 29 November 2011

2011-11-29T17:57:36Z

← Older revision		Revision as of 17:57, 29 November 2011
Line 33:		Line 33:
	When the element is char[n] and index is omitted the data returned is a String, otherwise it returns a number.		When the element is char[n] and index is omitted the data returned is a String, otherwise it returns a number.

−	When the element is byte[n] OR ubyte[n] and index is omitted ~~teh~~ data is returned as a Binary Variable example :	+	When the element is byte[n] OR ubyte[n] and index is omitted the data is returned as a Binary Variable example :
	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
	// Create a struct with a byte array of 20 in size		// Create a struct with a byte array of 20 in size

UberFoX: /* Remarks */

2011-11-29T17:48:32Z

Remarks

← Older revision		Revision as of 17:48, 29 November 2011
Line 36:		Line 36:
	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
	// Create a struct with a byte array of 20 in size		// Create a struct with a byte array of 20 in size
−	$Struct = DLLStructCreate("ubyte a[20]");	+	$Struct = DLLStructCreate("ubyte a[20]; ubyte b[5]");

	DLLStructSetData($Struct, "a", 12, 0);		DLLStructSetData($Struct, "a", 12, 0);
	DLLStructSetData($Struct, "a", 22, 1);		DLLStructSetData($Struct, "a", 22, 1);
	DLLStructSetData($Struct, "a", 44, 2);		DLLStructSetData($Struct, "a", 44, 2);
		+
		+	DLLStructSetData($Struct, "b", 44, 0);
		+	DLLStructSetData($Struct, "b", 66, 1);
		+	DLLStructSetData($Struct, "b", 88, 2);

	// Get the whole byte array and store it as Binary data		// Get the whole byte array and store it as Binary data
−	$~~Binary~~ = DLLStructGetData($Struct, "a");	+	$BinaryA = DLLStructGetData($Struct, "a");
		+
		+	println("\nData in A");
		+	Foreach ($BinaryA as $i)
		+	{
		+	println( "Byte: " . $i . " \| Hex: " . Hex($i) );
		+	}

−	~~// Loop through the binary elements~~	+	$BinaryB = DLLStructGetData($Struct, "b");
−	Foreach ($~~Binary~~ as $i)	+	println("\nData in B");
		+	Foreach ($BinaryB as $i)
	{		{
	println( "Byte: " . $i . " \| Hex: " . Hex($i) );		println( "Byte: " . $i . " \| Hex: " . Hex($i) );

UberFoX: /* Remarks */

2011-11-29T17:47:05Z

Remarks

← Older revision		Revision as of 17:47, 29 November 2011
Line 33:		Line 33:
	When the element is char[n] and index is omitted the data returned is a String, otherwise it returns a number.		When the element is char[n] and index is omitted the data returned is a String, otherwise it returns a number.

−	When the element is byte[n] OR ubyte[n] and index is omitted teh data is returned as a Binary Variable.	+	When the element is byte[n] OR ubyte[n] and index is omitted teh data is returned as a Binary Variable example :
		+	<syntaxhighlight lang="sputnik">
		+	// Create a struct with a byte array of 20 in size
		+	$Struct = DLLStructCreate("ubyte a[20]");
		+
		+	DLLStructSetData($Struct, "a", 12, 0);
		+	DLLStructSetData($Struct, "a", 22, 1);
		+	DLLStructSetData($Struct, "a", 44, 2);
		+
		+	// Get the whole byte array and store it as Binary data
		+	$Binary = DLLStructGetData($Struct, "a");
		+
		+	// Loop through the binary elements
		+	Foreach ($Binary as $i)
		+	{
		+	println( "Byte: " . $i . " \| Hex: " . Hex($i) );
		+	}
		+	</syntaxhighlight>

	=== Example ===		=== Example ===

UberFoX: /* Remarks */

2011-11-29T17:46:25Z

Remarks

← Older revision		Revision as of 17:46, 29 November 2011
Line 32:		Line 32:

	When the element is char[n] and index is omitted the data returned is a String, otherwise it returns a number.		When the element is char[n] and index is omitted the data returned is a String, otherwise it returns a number.
		+
		+	When the element is byte[n] OR ubyte[n] and index is omitted teh data is returned as a Binary Variable.

	=== Example ===		=== Example ===

UberFoX: /* index */

2011-11-29T12:08:14Z

index

← Older revision		Revision as of 12:08, 29 November 2011
Line 19:		Line 19:
	==== index ====		==== index ====

−	Optional; If the element is an array, you need to specify which index to return, otherwise it returns index 1. The first element is 1.	+	Optional; If the element is an array, you need to specify which index to return, otherwise it returns index 0. The first element is 0.

	=== Return Value ===		=== Return Value ===

UberFoX: Created page with "

 DLLStructGetData( , ,  )

=== Description === Returns the data of an element of the struct === Parameters === ==== dllstruct ==== Th..."

2011-11-29T12:06:37Z

Created page with "<pre> DLLStructGetData( <dllstruct>, <element>, <index> ) </pre> === Description === Returns the data of an element of the struct === Parameters === ==== dllstruct ==== Th..."

New page

<pre>
DLLStructGetData( <dllstruct>, <element>, <index> )
</pre>

=== Description ===

Returns the data of an element of the struct

=== Parameters ===

==== dllstruct ====

The struct returned by DLLStructCreate.

==== element ====

Which element of the struct you want to access by its element name as defined in DllStructCreate.

==== index ====

Optional; If the element is an array, you need to specify which index to return, otherwise it returns index 1. The first element is 1.

=== Return Value ===

Success: Data in the element of the struct.

Failure: 0.

=== Remarks ===

Used in DLLCall.

When the element is char[n] and index is omitted the data returned is a String, otherwise it returns a number.

=== Example ===

<syntaxhighlight lang="sputnik">
/*=========================================================
Create the struct
struct {
int var1;
unsigned char var2;
unsigned int var3;
char var4[128];
}
=========================================================*/

$str = "int var1;ubyte var2;uint var3;char var4[128]";
$a = DllStructCreate($str);
if ( !$a )
{
MsgBox("Error in DllStructCreate");
exit();
}

/*=========================================================
Set data in the struct
struct.var1 = -1;
struct.var2 = 255;
struct.var3 = 777;
strcpy(struct.var4,"Hello");
struct.var4[0] = 'h';
=========================================================*/
DllStructSetData($a,"var1",-1);
DllStructSetData($a,"var2",255);
DllStructSetData($a,"var3",777);
DllStructSetData($a,"var4","Hello");
DllStructSetData($a,"var4","G",0);

/*=========================================================
Display info in the struct
;=========================================================*/
MsgBox("Struct Size: " . DllStructGetSize($a) . @CRLF .
"Struct pointer: " . DllStructGetPtr($a) . @CRLF .
"Data:" . @CRLF .
DllStructGetData($a,"var1") . @CRLF .
DllStructGetData($a,"var2") . @CRLF .
DllStructGetData($a,"var3") . @CRLF .
DllStructGetData($a,"var4"),
"DllStruct");
</syntaxhighlight>

[[Category:Core Function]]