UberFoX: 1 revision

2015-06-14T12:37:33Z

1 revision

← Older revision

Revision as of 12:37, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:41:03Z

1 revision

← Older revision

Revision as of 21:41, 11 August 2014

UberFoX: /* Example */

2013-09-12T14:32:55Z

Example

← Older revision		Revision as of 14:32, 12 September 2013
Line 91:		Line 91:
	println("NO was pressed");		println("NO was pressed");
	}		}
		+	// Remove the DLL once we dont need it anymore
		+	DLLClose($Call);
	</syntaxhighlight>		</syntaxhighlight>

Line 115:		Line 117:
	println("NO was pressed");		println("NO was pressed");
	}		}
		+	// Remove the DLL once we dont need it anymore
		+	Unset($Call);
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

UberFoX at 14:31, 12 September 2013

2013-09-12T14:31:39Z

← Older revision		Revision as of 14:31, 12 September 2013
Line 5:		Line 5:
	=== Description ===		=== Description ===

−	Dynamically call a function in a DLL	+	Dynamically call a function in a DLL.

	=== Parameters ===		=== Parameters ===
Line 32:		Line 32:

	See [[Core Function DLLImport\|DLLImport( <varies...> )]] for CharSet/CallingConvention		See [[Core Function DLLImport\|DLLImport( <varies...> )]] for CharSet/CallingConvention
−
−	~~=== Return Value ===~~
−
−	~~See [[Core Function DLLImport\|DLLImport( <varies...> )]] for return value~~

	=== Params ===		=== Params ===

	None, one or more than one parameter to pass to the DLL function.		None, one or more than one parameter to pass to the DLL function.
		+
		+	=== Return Value ===
		+
		+	See [[Core Function DLLImport\|DLLImport( <varies...> )]] for return value

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

UberFoX at 14:25, 12 September 2013

2013-09-12T14:25:25Z

Show changes

UberFoX: Created page with "

 DLLImport( , , , ,  )

=== Description === See [[Core Function DLLImport|DLLImpor..."

2013-09-12T14:24:01Z

Created page with "<pre> DLLImport( <DLLName>, <FunctionName/Alias>, <ReturnType>, <ParameterType>, <CharSet/CallingConvention> ) </pre> === Description === See [[Core Function DLLImport|DLLImpor..."

New page

<pre>
DLLImport( <DLLName>, <FunctionName/Alias>, <ReturnType>, <ParameterType>, <CharSet/CallingConvention> )
</pre>

=== Description ===

See [[Core Function DLLImport|DLLImport( <varies...> )]] for description

=== Parameters ===

==== DLLName ====

The name of the DLL you want to import a function from

==== FunctionName/Alias ====

The function you wish to import from the DLL.

You can add an alias to the function for example if you want to import printf from msvcrt.dll but Sputnik already contains a printf you must alias the function by entering it like so:

"printf:myprintf" // This will import printf as normal but it will callable only by using the name myprintf

==== ReturnType ====

What type of return does this function do choices are:

<pre>
void
null
pointer
byte
sbyte
char
wchar
int16
int32
int64
uint16
uint32
uint64
float
double
string
*string
char*
</pre>

==== ParameterType ====

How many and what type of parameters does this function do choices are:

<pre>
[TYPE] [Description]
n NULL
b SByte
B Byte
s Int16
S UInt16
i Int32
I UInt32
l Int64
L UInt64
f Float
d Double
p String
t (IntPtr) Pointer (A numeric value but is an address of something)
T (UIntPtr) Pointer (A numeric value but is an address of something)
* Pointer READ BELOW:
% Array READ BELOW:
// Examples
ippi // Send Int32, String, String Int32
ip*pi // Send Int32, String, POINTER String Int32
fid // Send Float, Int32, Double
fi*d // Send Float, Int32, POINTER Double
i%pp // Send Int32, ARRAY String, String

About pointers:
The variable is passed as a POINTER and if the variable is modified in the DLL it modifies the actual Sputnik variable at the same time.

So if you send a $var as a *p string pointer then the DLL function runs lower case on the string the string in your $var will have changed too (Same for all data types including doubles, ints etc).

About arrays:
Currently arrays CANNOT also be passed as pointers (modifying the array in your DLL does not modify the array in Sputnik but evenutally I will make it so it does).

This allows you to send arrays of objects for example %p sends an array of strings such as array("one", "two", "three");

You can send arrays of everything even doubles and ints etc.

You cannot use ARRAY and POINTER at to the same variable example: %*p but you can use one or the other

Your $variable data is converted into the type you specify upon calling the function so if you put "d" for double and your variable contains a string it will convert it to a double.
</pre>

==== CharSet/CallingConvention ====

Here you define what char set and optionally what calling convention to use.

Choices are:
<pre>
"" // No char set will be used
"Void" // No char set will be used
"Ansi"
"Unicode"
"Auto" // It will try decide what it wants to use
// Now you can optionally decide if you want a
// calling convention for example if you are using a
// C/C++ DLL you need to use cdecl as the calling convention
// Choices of calling convention are:
cdecl
fastcall
stdcall
thiscall
winapi
// You must add them to the string using the : for example:
"Ansi:cdecl" // Use Ansi char set and cdecl calling convention
"Unicode:stdcall" // Use Unicode char set and stdcall calling convention
</pre>

=== Return Value ===

See [[Core Function DLLImport|DLLImport( <varies...> )]] for return value

=== Remarks ===

None.

=== Example ===

Example of using DLLCall() with all its parameters

<syntaxhighlight lang="sputnik">
// Setup a few variables
$MB_YESNO = 0x04;
$MB_ICONINFORMATION = 0x40;
$IDYES = 6;
// Make the call
$RetVal = DLLCall( 'User32.dll', 'MessageBox', 'Int32', 'ippi', 'Unicode',
0, "Hello There", "Title", $MB_YESNO | $MB_ICONINFORMATION
);
If ( $RetVal == $IDYES )
{
println("YES was pressed");
}
else
{
println("NO was pressed");
}
</syntaxhighlight>

Example of using DLLCall() with minimal parameters by using DLLOpen() to avoid having to redefine the function

<syntaxhighlight lang="sputnik">
// Store the DLL function to call later
$Call = DLLOpen('User32.dll', 'MessageBox', 'Int32', 'ippi', 'Unicode');
// Setup a few variables
$MB_YESNO = 0x04;
$MB_ICONINFORMATION = 0x40;
$IDYES = 6;
// Make the call
$RetVal = DLLCall($Call, 0, "Hello There", "Title", $MB_YESNO | $MB_ICONINFORMATION);
If ( $RetVal == $IDYES )
{
println("YES was pressed");
}
else
{
println("NO was pressed");
}
</syntaxhighlight>

Example of using DLLCall() with the Library class "API" from "Win32" folder this class provides a wrapper for DLLOpen() DLLImport() DLLClose() and DLLCall() all rolled into one it works similar to how Perl calls APIs.

<syntaxhighlight lang="sputnik">
// Include the API class
Include('Win32/API.spk');

// Store the DLL function to call later
my $Call = new API('User32.dll', 'MessageBox', 'Int32', 'ippi', 'Unicode');
// Setup a few variables
$MB_YESNO = 0x04;
$MB_ICONINFORMATION = 0x40;
$IDYES = 6;
// Make the call
$RetVal = $Call->Call(0, "Hello There", "Title", $MB_YESNO | $MB_ICONINFORMATION);
If ( $RetVal == $IDYES )
{
println("YES was pressed");
}
else
{
println("NO was pressed");
}
</syntaxhighlight>

[[Category:Core Function]]

Core Function DLLCall - Revision history

UberFoX: 1 revision

UberFoX: 1 revision

UberFoX: /* Example */

UberFoX at 14:31, 12 September 2013

UberFoX at 14:25, 12 September 2013

UberFoX: Created page with "
DLLImport( , , , , )
=== Description === See [[Core Function DLLImport|DLLImpor..."