Back to Aurora Vision Library website

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

SiliconSoftware_GetStringParameter


Header: ThirdPartySdk.h
Namespace: avl
Module: ThirdParty

Gets parameter of type String.

Syntax

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

Parameters

Name Type Range Default Description
Input will be modified ioState SiliconSoftware_State& Object used to maintain state of the function.
Input value inDeviceIndex Optional<int> 0 - NIL Device identifying number
Input value inAppletPath Optional<const String&> NIL Applet to load
Input value inPort int 0 - DMA port
Input value inName const String& Parameter name
Output value 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.