HelpWizard Pages ReferenceManual1 C/en - Versionsgeschichte

Cg am 10. März 2021 um 19:59 Uhr

2021-03-10T19:59:45Z

← Nächstältere Version		Version vom 10. März 2021, 19:59 Uhr
Zeile 1:		Zeile 1:
	[[Datei:arrowup.png\|link=HelpWizard Pages ReferenceManual1/en\|up]]		[[Datei:arrowup.png\|link=HelpWizard Pages ReferenceManual1/en\|up]]
	[[Datei:arrowright.png\|link=HelpWizard Pages ReferenceManual2 C/en\|~~back~~]]		[[Datei:arrowright.png\|link=HelpWizard Pages ReferenceManual2 C/en\|next]]

	== Reference Manual C API (Normal Pins) ==		== Reference Manual C API (Normal Pins) ==

Cg am 10. März 2021 um 19:17 Uhr

2021-03-10T19:17:33Z

← Nächstältere Version		Version vom 10. März 2021, 19:17 Uhr
Zeile 1:		Zeile 1:
	[[Datei:arrowup.png\|link=HelpWizard Pages ReferenceManual1/en\|up]]		[[Datei:arrowup.png\|link=HelpWizard Pages ReferenceManual1/en\|up]]
			[[Datei:arrowright.png\|link=HelpWizard Pages ReferenceManual2 C/en\|back]]

	== Reference Manual C API (Normal Pins) ==		== Reference Manual C API (Normal Pins) ==

Cg: /* Reference Manual C API (Normal Pins) */

2021-03-10T18:49:22Z

Reference Manual C API (Normal Pins)

← Nächstältere Version		Version vom 10. März 2021, 18:49 Uhr
Zeile 60:		Zeile 60:

	* void '''putPointer'''(''outputPinName'' void* ''pointer'')<br>send a pointer to the output pin, which must be of type Any, Handle or a C-struct type. The pointer is treated as an opaque handle by expecco, and can be sent to an input pin of another C action (which must of course execute on the same bridge). The receiving action should fetch it via pointerValue() from its input pin.		* void '''putPointer'''(''outputPinName'' void* ''pointer'')<br>send a pointer to the output pin, which must be of type Any, Handle or a C-struct type. The pointer is treated as an opaque handle by expecco, and can be sent to an input pin of another C action (which must of course execute on the same bridge). The receiving action should fetch it via pointerValue() from its input pin.

			[[Category: HelpWizard/en]]
			[[Category: HelpWizard API/en]]
			[[Category: HelpWizard API C/en]]

Cg am 8. März 2021 um 13:15 Uhr

2021-03-08T13:15:51Z

← Nächstältere Version		Version vom 8. März 2021, 13:15 Uhr
Zeile 1:		Zeile 1:
	[[Datei:arrowup.png\|link=HelpWizard Pages ReferenceManual1/en\|up]]		[[Datei:arrowup.png\|link=HelpWizard Pages ReferenceManual1/en\|up]]

			== Reference Manual C API (Normal Pins) ==

	<strong>Input</strong>		<strong>Input</strong>

Cg am 8. März 2021 um 12:29 Uhr

2021-03-08T12:29:10Z

← Nächstältere Version		Version vom 8. März 2021, 12:29 Uhr
Zeile 1:		Zeile 1:
			[[Datei:arrowup.png\|link=HelpWizard Pages ReferenceManual1/en\|up]]

	<strong>Input</strong>		<strong>Input</strong>

Cg am 5. März 2021 um 14:07 Uhr

2021-03-05T14:07:51Z

← Nächstältere Version		Version vom 5. März 2021, 14:07 Uhr
Zeile 11:		Zeile 11:
	* char* '''stringValue'''(''inputPinName'')<br>ditto for String typed pins.		* char* '''stringValue'''(''inputPinName'')<br>ditto for String typed pins.

	* wchar* '''wideStringValue'''(''inputPinName'')<br>ditto for wide strings.		<!-- * wchar* '''wideStringValue'''(''inputPinName'')<br>ditto for wide strings.-->
			* jsonObject '''jsonValue'''(''inputPinName'')<br>retrieve any value which can be represented in JSON (i.e. may not have pointers in it).

	* void* '''pointerValue'''(''inputPinName'')<br>fetch a pointer. This pointer MUST have been generated in a previous action (in the same bridge), and been sent to expecco via <code>putPointer()</code>.		* void* '''pointerValue'''(''inputPinName'')<br>fetch a pointer. This pointer MUST have been generated in a previous action (in the same bridge), and been sent to expecco via <code>putPointer()</code>.
Zeile 52:		Zeile 53:

	* void '''putBytes'''(''outputPinName'' unsigned char* ''bytes'', int ''len'')<br>ditto for byte data. The pin's type can be ByteArray or a C-struct type.		* void '''putBytes'''(''outputPinName'' unsigned char* ''bytes'', int ''len'')<br>ditto for byte data. The pin's type can be ByteArray or a C-struct type.

			* void '''putJSON'''(''outputPinName'' jsonObject ''value'')<br>ditto for a json object

	* void '''putPointer'''(''outputPinName'' void* ''pointer'')<br>send a pointer to the output pin, which must be of type Any, Handle or a C-struct type. The pointer is treated as an opaque handle by expecco, and can be sent to an input pin of another C action (which must of course execute on the same bridge). The receiving action should fetch it via pointerValue() from its input pin.		* void '''putPointer'''(''outputPinName'' void* ''pointer'')<br>send a pointer to the output pin, which must be of type Any, Handle or a C-struct type. The pointer is treated as an opaque handle by expecco, and can be sent to an input pin of another C action (which must of course execute on the same bridge). The receiving action should fetch it via pointerValue() from its input pin.

Cg am 5. März 2021 um 13:39 Uhr

2021-03-05T13:39:49Z

Cg am 5. März 2021 um 13:38 Uhr

2021-03-05T13:38:44Z

Cg am 5. März 2021 um 13:37 Uhr

2021-03-05T13:37:26Z

← Nächstältere Version		Version vom 5. März 2021, 13:37 Uhr
Zeile 3:		Zeile 3:
	<br>These functions will report an error, if the pin has no value.		<br>These functions will report an error, if the pin has no value.

	* long '''longValue'''(''inputPinName'')<br>fetch an integer value from an integer typed input pin; reports an error, if there is no value.		* long '''longValue'''(''inputPinName'')<br>fetch an integer value from an integer typed input pin; reports an error, if there is no value.

	* double '''doubleValue'''(''inputPinName'')<br>ditto for Float typed pins. Notice, that expecco (and other languages) represents all floating point numbers internally as double precision IEEE floats. Even though the type is called ''Float''.		* double '''doubleValue'''(''inputPinName'')<br>ditto for Float typed pins. Notice, that expecco (and other languages) represents all floating point numbers internally as double precision IEEE floats. Even though the type is called ''Float''.
Zeile 15:		Zeile 15:
	* void* '''pointerValue'''(''inputPinName'')<br>fetch a pointer. This pointer MUST have been generated in a previous action (in the same bridge), and been sent to expecco via <code>putPointer()</code>.		* void* '''pointerValue'''(''inputPinName'')<br>fetch a pointer. This pointer MUST have been generated in a previous action (in the same bridge), and been sent to expecco via <code>putPointer()</code>.

			<strong>Input with Default</strong>
	<br>These functions will return a default (zero or NULL), if the pin has no value.		<br>These functions will return a default (zero or NULL), if the pin has no value.

Zeile 27:		Zeile 28:
	* void* '''pointerValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns NULL		* void* '''pointerValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns NULL

			<strong>Input with Alternative</strong>
	<br>These functions will return a specific alternative value if the pin has no value.		<br>These functions will return a specific alternative value if the pin has no value.

Cg am 5. März 2021 um 13:35 Uhr

2021-03-05T13:35:30Z

← Nächstältere Version		Version vom 5. März 2021, 13:35 Uhr
Zeile 38:		Zeile 38:

	<strong>Testing</strong>		<strong>Testing</strong>
	* bool_t hasValue(''inputPinName'')<br>true if the input pin has a value; false if not		* bool_t '''hasValue'''(''inputPinName'')<br>true if the input pin has a value; false if not

	<strong>Output</strong>		<strong>Output</strong>
	* void '''putLong(''outputPinName'', long ''value'')<br>send an integer (long) value to the output pin. The output pin's type must be compatible.		* void '''putLong'''(''outputPinName'', long ''value'')<br>send an integer (long) value to the output pin. The output pin's type must be compatible.

	* void '''putDouble(''outputPinName'' double ''value'')<br>send a double value to the output pin		* void '''putDouble'''(''outputPinName'' double ''value'')<br>send a double value to the output pin

	* void '''putBoolean(''outputPinName'' bool_t ''value'')<br>ditto for booleans		* void '''putBoolean'''(''outputPinName'' bool_t ''value'')<br>ditto for booleans

	* void '''putString(''outputPinName'' char* ''value'')<br>ditto for strings		* void '''putString'''(''outputPinName'' char* ''value'')<br>ditto for strings

	* void '''putBytes(''outputPinName'' unsigned char* ''bytes'', int ''len'')<br>ditto for byte data. The pin's type can be ByteArray or a C-struct type.		* void '''putBytes'''(''outputPinName'' unsigned char* ''bytes'', int ''len'')<br>ditto for byte data. The pin's type can be ByteArray or a C-struct type.

	* void '''putPointer(''outputPinName'' void* ''pointer'')<br>send a pointer to the output pin, which must be of type Any, Handle or a C-struct type. The pointer is treated as an opaque handle by expecco, and can be sent to an input pin of another C action (which must of course execute on the same bridge). The receiving action should fetch it via pointerValue() from its input pin.		* void '''putPointer'''(''outputPinName'' void* ''pointer'')<br>send a pointer to the output pin, which must be of type Any, Handle or a C-struct type. The pointer is treated as an opaque handle by expecco, and can be sent to an input pin of another C action (which must of course execute on the same bridge). The receiving action should fetch it via pointerValue() from its input pin.

← Nächstältere Version		Version vom 5. März 2021, 13:39 Uhr
Zeile 31:		Zeile 31:
	<br>These functions will return a specific alternative value if the pin has no value.		<br>These functions will return a specific alternative value if the pin has no value.

	* long '''longValueIfAbsent'''(''inputPinName'', long ''defaultValue'')<br>if the input pin has a value, fetch it; otherwise returns defaultValue.		* long '''longValueIfAbsent'''(''inputPinName'', long ''defaultValue'')<br>if the input pin has a value, fetch it; otherwise returns defaultValue.

	* long '''doubleValueIfAbsent'''(''inputPinName'', double ''defaultValue'')<br>ditto for doubles.		* long '''doubleValueIfAbsent'''(''inputPinName'', double ''defaultValue'')<br>ditto for doubles.

	* long '''booleanValueIfAbsent'''(''inputPinName'', bool_t ''defaultValue'')<br>ditto for booleans.		* long '''booleanValueIfAbsent'''(''inputPinName'', bool_t ''defaultValue'')<br>ditto for booleans.

	* long '''pointerValueIfAbsent'''(''inputPinName'', void* ''defaultValue'')<br>ditto for pointers.		* long '''pointerValueIfAbsent'''(''inputPinName'', void* ''defaultValue'')<br>ditto for pointers.

	<strong>Testing</strong>		<strong>Testing</strong>
Zeile 43:		Zeile 43:

	<strong>Output</strong>		<strong>Output</strong>
	* void '''putLong'''(''outputPinName'', long ''value'')<br>send an integer (long) value to the output pin. The output pin's type must be compatible.		* void '''putLong'''(''outputPinName'', long ''value'')<br>send an integer (long) value to the output pin. The output pin's type must be compatible.

	* void '''putDouble'''(''outputPinName'' double ''value'')<br>send a double value to the output pin		* void '''putDouble'''(''outputPinName'' double ''value'')<br>send a double value to the output pin

	* void '''putBoolean'''(''outputPinName'' bool_t ''value'')<br>ditto for booleans		* void '''putBoolean'''(''outputPinName'' bool_t ''value'')<br>ditto for booleans

	* void '''putString'''(''outputPinName'' char* ''value'')<br>ditto for strings		* void '''putString'''(''outputPinName'' char* ''value'')<br>ditto for strings

	* void '''putBytes'''(''outputPinName'' unsigned char* ''bytes'', int ''len'')<br>ditto for byte data. The pin's type can be ByteArray or a C-struct type.		* void '''putBytes'''(''outputPinName'' unsigned char* ''bytes'', int ''len'')<br>ditto for byte data. The pin's type can be ByteArray or a C-struct type.

	* void '''putPointer'''(''outputPinName'' void* ''pointer'')<br>send a pointer to the output pin, which must be of type Any, Handle or a C-struct type. The pointer is treated as an opaque handle by expecco, and can be sent to an input pin of another C action (which must of course execute on the same bridge). The receiving action should fetch it via pointerValue() from its input pin.		* void '''putPointer'''(''outputPinName'' void* ''pointer'')<br>send a pointer to the output pin, which must be of type Any, Handle or a C-struct type. The pointer is treated as an opaque handle by expecco, and can be sent to an input pin of another C action (which must of course execute on the same bridge). The receiving action should fetch it via pointerValue() from its input pin.

← Nächstältere Version		Version vom 5. März 2021, 13:38 Uhr
Zeile 5:		Zeile 5:
	* long '''longValue'''(''inputPinName'')<br>fetch an integer value from an integer typed input pin; reports an error, if there is no value.		* long '''longValue'''(''inputPinName'')<br>fetch an integer value from an integer typed input pin; reports an error, if there is no value.

	* double '''doubleValue'''(''inputPinName'')<br>ditto for Float typed pins. Notice, that expecco (and other languages) represents all floating point numbers internally as double precision IEEE floats. Even though the type is called ''Float''.		* double '''doubleValue'''(''inputPinName'')<br>ditto for Float typed pins. Notice, that expecco (and other languages) represents all floating point numbers internally as double precision IEEE floats. Even though the type is called ''Float''.

	* bool_t '''booleanValue'''(''inputPinName'')<br>ditto for Boolean typed pins.		* bool_t '''booleanValue'''(''inputPinName'')<br>ditto for Boolean typed pins.

	* char* '''stringValue'''(''inputPinName'')<br>ditto for String typed pins.		* char* '''stringValue'''(''inputPinName'')<br>ditto for String typed pins.

	* wchar* '''wideStringValue'''(''inputPinName'')<br>ditto for wide strings.		* wchar* '''wideStringValue'''(''inputPinName'')<br>ditto for wide strings.

	* void* '''pointerValue'''(''inputPinName'')<br>fetch a pointer. This pointer MUST have been generated in a previous action (in the same bridge), and been sent to expecco via <code>putPointer()</code>.		* void* '''pointerValue'''(''inputPinName'')<br>fetch a pointer. This pointer MUST have been generated in a previous action (in the same bridge), and been sent to expecco via <code>putPointer()</code>.

	<strong>Input with Default</strong>		<strong>Input with Default</strong>
	<br>These functions will return a default (zero or NULL), if the pin has no value.		<br>These functions will return a default (zero or NULL), if the pin has no value.

	* long '''longValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns 0		* long '''longValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns 0

	* double '''doubleValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns 0.0		* double '''doubleValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns 0.0

	* bool_t '''booleanValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns 0 (false)		* bool_t '''booleanValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns 0 (false)

	* char* '''stringValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns NULL		* char* '''stringValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns NULL

	* void* '''pointerValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns NULL		* void* '''pointerValueIfPresent'''(''inputPinName'')<br>if the input pin has a value, fetch it; otherwise returns NULL

	<strong>Input with Alternative</strong>		<strong>Input with Alternative</strong>
	<br>These functions will return a specific alternative value if the pin has no value.		<br>These functions will return a specific alternative value if the pin has no value.

	* long '''longValueIfAbsent'''(''inputPinName'', long ''defaultValue'')<br>if the input pin has a value, fetch it; otherwise returns defaultValue.		* long '''longValueIfAbsent'''(''inputPinName'', long ''defaultValue'')<br>if the input pin has a value, fetch it; otherwise returns defaultValue.

	* long '''doubleValueIfAbsent'''(''inputPinName'', double ''defaultValue'')<br>ditto for doubles.		* long '''doubleValueIfAbsent'''(''inputPinName'', double ''defaultValue'')<br>ditto for doubles.

	* long '''booleanValueIfAbsent'''(''inputPinName'', bool_t ''defaultValue'')<br>ditto for booleans.		* long '''booleanValueIfAbsent'''(''inputPinName'', bool_t ''defaultValue'')<br>ditto for booleans.

	* long '''pointerValueIfAbsent'''(''inputPinName'', void* ''defaultValue'')<br>ditto for pointers.		* long '''pointerValueIfAbsent'''(''inputPinName'', void* ''defaultValue'')<br>ditto for pointers.

	<strong>Testing</strong>		<strong>Testing</strong>
	* bool_t '''hasValue'''(''inputPinName'')<br>true if the input pin has a value; false if not		* bool_t '''hasValue'''(''inputPinName'')<br>true if the input pin has a value; false if not

	<strong>Output</strong>		<strong>Output</strong>
	* void '''putLong'''(''outputPinName'', long ''value'')<br>send an integer (long) value to the output pin. The output pin's type must be compatible.		* void '''putLong'''(''outputPinName'', long ''value'')<br>send an integer (long) value to the output pin. The output pin's type must be compatible.

	* void '''putDouble'''(''outputPinName'' double ''value'')<br>send a double value to the output pin		* void '''putDouble'''(''outputPinName'' double ''value'')<br>send a double value to the output pin

	* void '''putBoolean'''(''outputPinName'' bool_t ''value'')<br>ditto for booleans		* void '''putBoolean'''(''outputPinName'' bool_t ''value'')<br>ditto for booleans

	* void '''putString'''(''outputPinName'' char* ''value'')<br>ditto for strings		* void '''putString'''(''outputPinName'' char* ''value'')<br>ditto for strings

	* void '''putBytes'''(''outputPinName'' unsigned char* ''bytes'', int ''len'')<br>ditto for byte data. The pin's type can be ByteArray or a C-struct type.		* void '''putBytes'''(''outputPinName'' unsigned char* ''bytes'', int ''len'')<br>ditto for byte data. The pin's type can be ByteArray or a C-struct type.

	* void '''putPointer'''(''outputPinName'' void* ''pointer'')<br>send a pointer to the output pin, which must be of type Any, Handle or a C-struct type. The pointer is treated as an opaque handle by expecco, and can be sent to an input pin of another C action (which must of course execute on the same bridge). The receiving action should fetch it via pointerValue() from its input pin.		* void '''putPointer'''(''outputPinName'' void* ''pointer'')<br>send a pointer to the output pin, which must be of type Any, Handle or a C-struct type. The pointer is treated as an opaque handle by expecco, and can be sent to an input pin of another C action (which must of course execute on the same bridge). The receiving action should fetch it via pointerValue() from its input pin.