Technical Reference:BCI2000Remote Library - Revision history

Mellinger: /* BCI2000Remote Member Functions */

2026-04-28T15:53:44Z

BCI2000Remote Member Functions

← Older revision		Revision as of 15:53, 28 April 2026
Line 38:		Line 38:
	==BCI2000Remote Member Functions==		==BCI2000Remote Member Functions==
	The following functions are property accessors, and member functions of BCI2000Remote		The following functions are property accessors, and member functions of BCI2000Remote
	objects. For documentation, see "Programming Reference:BCI2000Remote Class" on		objects. For documentation, see [[Programming Reference:BCI2000Remote Class]] on
	the BCI2000 wiki.		the BCI2000 wiki.
	In the C-style interface, each function takes a handle to an existing BCI2000Remote		In the C-style interface, each function takes a handle to an existing BCI2000Remote

Mellinger: /* See also */

2025-06-19T20:33:34Z

Wengelhardt: /* const char* BCI2000Remote_GetResult( void* ) */

2025-04-17T15:53:00Z

const char* BCI2000Remote_GetResult( void* )

← Older revision		Revision as of 15:53, 17 April 2025
Line 70:		Line 70:

	===const char* BCI2000Remote_GetResult( void* )===		===const char* BCI2000Remote_GetResult( void* )===
			Returns the string result of the previous command.

	===const char* BCI2000Remote_GetSubjectID( void* )===		===const char* BCI2000Remote_GetSubjectID( void* )===

Mellinger: /* int BCI2000Remote_Execute( void, const char ) */

2025-04-17T12:11:34Z

int BCI2000Remote_Execute( void*, const char* )

← Older revision		Revision as of 12:11, 17 April 2025
Line 83:		Line 83:
	===int BCI2000Remote_Disconnect( void* )===		===int BCI2000Remote_Disconnect( void* )===

	===int BCI2000Remote_Execute( void, const char )===		===int BCI2000Remote_Execute( void, const char, int* )===
	NB: This function returns the last command's execution status, which		NB: This function returns the last command's execution status, which
	is a true integer, with a value of 0 indicating success in most cases.		is a true integer, with a value of 0 indicating success in most cases.
	All other int-returning functions return a boolean integer which is		All other int-returning functions return a boolean integer which is
	1 on success, and 0 on failure.		1 on success, and 0 on failure.

			The last argument (which may be a null pointer) holds a pointer to an integer
			that receives the parsed string result of the command, which is typically 1
			for success, and 0 for failure.

			To obtain the actual string result of an executed command, call <tt>BCI2000Remote_GetResult()</tt>
			immediately after calling the <tt>BCI2000RemoteExecute()</tt> command.

	===int BCI2000Remote_StartupModules( void, const char )===		===int BCI2000Remote_StartupModules( void, const char )===

Mellinger: /* BCI2000Remote Member Functions */

2023-04-04T13:08:49Z

BCI2000Remote Member Functions

← Older revision		Revision as of 13:08, 4 April 2023
Line 42:		Line 42:
	In the C-style interface, each function takes a handle to an existing BCI2000Remote		In the C-style interface, each function takes a handle to an existing BCI2000Remote
	object as its first argument. Use BCI2000Remote_New() to create such objects.		object as its first argument. Use BCI2000Remote_New() to create such objects.
	When a function returns a C string, the ~~caller is responsible for releasing that~~ string		When a function returns a C string, the string exists in a per-thread buffer, and may not be
	~~once it is done with it~~. ~~This is done by~~ calling BCI2000Release() on the string.		released by the caller. For backward compatibility, calling BCI2000Release() on the string is allowed but will have no effect.
	Functions that return a C string may return NULL to indicate failure.		Functions that return a C string may return NULL to indicate failure.

Mellinger: /* Functions specific to the Library */

2023-04-04T13:07:05Z

Functions specific to the Library

← Older revision		Revision as of 13:07, 4 April 2023
Line 2:		Line 2:

	==Functions specific to the Library==		==Functions specific to the Library==
	~~===int BCI2000Release( void* )===~~
	~~purpose: Releases a string buffer, or other object allocated by the library.~~

	~~arguments: String pointer, or handle to object allocated by one of the library functions.~~

	~~returns: 1 if successful, 0 otherwise.~~

	===void* BCI2000Remote_New( void )===		===void* BCI2000Remote_New( void )===

Mellinger at 13:03, 4 April 2023

2023-04-04T13:03:18Z

← Older revision		Revision as of 13:03, 4 April 2023
Line 121:		Line 121:
	===int BCI2000Remote_SetStateVariable( void, const char, double )===		===int BCI2000Remote_SetStateVariable( void, const char, double )===
	===int BCI2000Remote_GetStateVariable( void, const char, double* )===		===int BCI2000Remote_GetStateVariable( void, const char, double* )===
			===int BCI2000Remote_AddEventVariable( void, const char name, unsigned int bitWidth, double initialValue )===
			===int BCI2000Remote_SetEventVariable( void, const char, double )===
			===int BCI2000Remote_PulseEventVariable( void, const char, double )===
			===int BCI2000Remote_GetEventVariable( void, const char, double* )===

	===int BCI2000Remote_SetScript( void, const char, const char* )===		===int BCI2000Remote_SetScript( void, const char, const char* )===

Mellinger: /* int BCI2000Remote_StartupModules( void, const char ) */

2021-11-23T16:34:54Z

int BCI2000Remote_StartupModules( void*, const char* )

← Older revision		Revision as of 16:34, 23 November 2021
Line 99:		Line 99:
	with command line arguments in the form		with command line arguments in the form
	const char* list = "module1 -arg1 -arg2\0module2 -arg1\0module3 -arg1\0\0";		const char* list = "module1 -arg1 -arg2\0module2 -arg1\0module3 -arg1\0\0";

			===int BCI2000Remote_StartupModules2( void, const char*, int )===
			As an alternative to <tt>StartupModules()</tt>, provide an array of <tt>const char*</tt> in the second argument,
			and the number of entries in the array in the third:
			const char* list[] = { "module1 -arg1 -arg2", "module2 -arg1", "module3 -arg1" };
			int result = BCI2000Remote_StartupModules2(handle, list, 3);

	===int BCI2000Remote_LoadParametersLocal( void, const char )===		===int BCI2000Remote_LoadParametersLocal( void, const char )===
	===int BCI2000Remote_LoadParametersRemote( void, const char )===		===int BCI2000Remote_LoadParametersRemote( void, const char )===

Mellinger: /* void* BCI2000Remote_NewWatch( void* bci2000RemoteObject, const char* expression, WatchCallback, void* ) */

2021-08-18T15:10:07Z

void* BCI2000Remote_NewWatch( void* bci2000RemoteObject, const char* expression, WatchCallback, void* )

← Older revision		Revision as of 15:10, 18 August 2021
Line 32:		Line 32:

	arguments: Handle to an existing BCI2000Remote object; Expression to watch; Pointer to callback function; Pointer to user data for callback function.		arguments: Handle to an existing BCI2000Remote object; Expression to watch; Pointer to callback function; Pointer to user data for callback function.

	returns: Handle to newly created watch, or NULL if not successful.		returns: Handle to newly created watch, or NULL if not successful.

Mellinger: /* void WatchCallback( void, const char ) */

2021-08-18T15:09:45Z

void WatchCallback( void*, const char* )

← Older revision		Revision as of 15:09, 18 August 2021
Line 26:		Line 26:
	purpose: Prototype for a callback function that is called when a watch is triggered.		purpose: Prototype for a callback function that is called when a watch is triggered.

	arguments: Pointer to user data as specified when <tt>BCI2000Remote_NewWatch()</tt> was called.		arguments: Pointer to user data as specified when <tt>BCI2000Remote_NewWatch()</tt> was called; values of expressions that triggered the watch.

	===void* BCI2000Remote_NewWatch( void* bci2000RemoteObject, const char* expression, WatchCallback, void* )===		===void* BCI2000Remote_NewWatch( void* bci2000RemoteObject, const char* expression, WatchCallback, void* )===

← Older revision		Revision as of 20:33, 19 June 2025
Line 132:		Line 132:

	==See also==		==See also==
	[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000Command]], [[Contributions:BCI2000PresentationLink]], [[Contributions:BCI2000Automation]]		[[Programming Reference:BCI2000Remote Class]], [[Contributions:BCI2000Command]], [[Contributions:BCI2000PresentationLink]], <!--[[Contributions:BCI2000Automation]],-->
	[[Contributions:Applications]]		[[Contributions:Applications]]

	[[Category:External Interfaces]][[Category:User Application]]		[[Category:External Interfaces]][[Category:User Application]]

← Older revision		Revision as of 13:03, 4 April 2023
Line 121:		Line 121:
	===int BCI2000Remote_SetStateVariable( void, const char, double )===		===int BCI2000Remote_SetStateVariable( void, const char, double )===
	===int BCI2000Remote_GetStateVariable( void, const char, double* )===		===int BCI2000Remote_GetStateVariable( void, const char, double* )===
			===int BCI2000Remote_AddEventVariable( void, const char name, unsigned int bitWidth, double initialValue )===
			===int BCI2000Remote_SetEventVariable( void, const char, double )===
			===int BCI2000Remote_PulseEventVariable( void, const char, double )===
			===int BCI2000Remote_GetEventVariable( void, const char, double* )===

	===int BCI2000Remote_SetScript( void, const char, const char* )===		===int BCI2000Remote_SetScript( void, const char, const char* )===

Technical Reference:BCI2000Remote Library - Revision history

Mellinger: /* BCI2000Remote Member Functions */

Mellinger: /* See also */

Wengelhardt: /* const char* BCI2000Remote_GetResult( void* ) */

Mellinger: /* int BCI2000Remote_Execute( void*, const char* ) */

Mellinger: /* BCI2000Remote Member Functions */

Mellinger: /* Functions specific to the Library */

Mellinger at 13:03, 4 April 2023

Mellinger: /* int BCI2000Remote_StartupModules( void*, const char* ) */

Mellinger: /* void* BCI2000Remote_NewWatch( void* bci2000RemoteObject, const char* expression, WatchCallback, void* ) */

Mellinger: /* void WatchCallback( void*, const char* ) */

Mellinger: /* int BCI2000Remote_Execute( void, const char ) */

Mellinger: /* int BCI2000Remote_StartupModules( void, const char ) */

Mellinger: /* void WatchCallback( void, const char ) */