Back to FabImage Library website

You are here: Start » Function Reference » SiliconSoftware » SiliconSoftware_GetStringParameter

SiliconSoftware_GetStringParameter


Header:ThirdPartySdk.h
Namespace:fil

Gets parameter of type String.

Syntax

void fil::SiliconSoftware_GetStringParameter
(
	SiliconSoftware_State& ioState,
	ftl::Optional<int> inDeviceIndex,
	ftl::Optional<const ftl::String&> inAppletPath,
	int inPort,
	const ftl::String& inName,
	ftl::String& outValue
)

Parameters

Name Type Range Default Description
ioState SiliconSoftware_State& Object used to maintain state of the function.
inDeviceIndex Optional<int> 0 - NIL Device identifying number
inAppletPath Optional<const String&> NIL Applet to load
inPort int 0 - DMA port
inName const String& Parameter name
outValue String& Parameter value

Multithreaded environment

This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.