IAdvancedParameterAccess Interface#

Provides advanced parameter services.

Syntax#

C#

public interface IAdvancedParameterAccess

VB

Public Interface IAdvancedParameterAccess

The IAdvancedParameterAccess type exposes the following members.

Methods#

	Name	Description
	ContainsProperty	Returns true if the property key passed exists.
	GetLock	Advanced: Returns the object used to lock access to the parameter.
	GetProperty	Returns the value for the property specified by the key.
	GetPropertyOrDefault	Gets the property value if the given property key exists. Otherwise, returns the default value.
	Refresh	Invalidates all cached values.
	SetProperty	Sets the value for the property specified by the key.

IAdvancedParameterAccess.ContainsProperty Method#

Returns true if the property key passed exists.

Syntax#

C#

bool ContainsProperty(
    string key
)

VB

Function ContainsProperty ( 
    key As String
) As Boolean

Parameters#

key: Type: System.String
String containing the name of the property. You can use the AdvancedParameterAccessKey class to get a list of possible values.

Return Value#

Type: Boolean
Returns true if the property key passed exists.

Remarks#

Thread Safety:This method is synchronized with the source of the parameter collection, if any.

Error Safety:Does not throw exceptions.

IAdvancedParameterAccess.GetLock Method#

Advanced: Returns the object used to lock access to the parameter.

Syntax#

C#

Object GetLock()

VB

Function GetLock As Object

Return Value#

Type: Object
Returns the object used to lock access to the parameter. If there is no lock object a null reference will be returned.

Remarks#

Returns the object used to lock the access to the parameter. This is an advanced function.

For each successful acquisition of the lock you must release the lock. Failure to do so may result in lockups and indeterministic behaviour of pylon objects.

Thread Safety:This method is thread-safe.

Error Safety:Does not throw exceptions.

IAdvancedParameterAccess.GetProperty Method#

Returns the value for the property specified by the key.

Syntax#

C#

string GetProperty(
    string key
)

VB

Function GetProperty ( 
    key As String
) As String

Parameters#

key: Type: System.String
String containing the name of the property. You can use the AdvancedParameterAccessKey class to get a list of possible values.

Return Value#

Type: String
Returns the string value for the property specified by the key.

Remarks#

Thread Safety:This method is synchronized with the source of the parameter collection, if any.

Error Safety: Can throw exceptions. Throws a System.ArgumentNullException if the key passed is null. Throws a System.NotSupportedException if the key passed is not supported.

IAdvancedParameterAccess.GetPropertyOrDefault Method#

Gets the property value if the given property key exists. Otherwise, returns the default value.

Syntax#

C#

string GetPropertyOrDefault(
    string key,
    string defaultValue
)

VB

Function GetPropertyOrDefault ( 
    key As String,
    defaultValue As String
) As String

Parameters#

key: Type: System.String
The key of the property to look up. The comparison is case sensitive.
defaultValue: Type: System.String
The default value returned if the property key is not found.

Return Value#

Type: String
Returns the property value if the given property key exists. Otherwise, returns the default value.

Remarks#

Thread Safety:This method is synchronized with the source of the parameter collection, if any.

Error Safety: Can throw exceptions.

IAdvancedParameterAccess.Refresh Method#

Invalidates all cached values.

Syntax#

C#

void Refresh()

VB

Sub Refresh

Remarks#

Some parameter values are cached, e.g. to minimize the overhead while communicating with a camera device. You can call this method to force an invalidation of the cached values. On the next read of the parameter, the value will be read from the source instead of returning a cached value. This will raise a ParameterChanged event. This method can be used to reread the value in the ParameterChanged event handler.

Thread Safety:This method is synchronized with the source of the parameter collection, if any.

Error Safety:Can throw exceptions. Parameter event handlers can throw exceptions.

IAdvancedParameterAccess.SetProperty Method#

Sets the value for the property specified by the key.

Syntax#

C#

void SetProperty(
    string key,
    string value
)

VB

Sub SetProperty ( 
    key As String,
    value As String
)

Parameters#

key: Type: System.String
String containing the name of the property. You can use the AdvancedParameterAccessKey class to get a list of possible values.
value: Type: System.String
String containing the value of the property to set.

Remarks#

Thread Safety:This method is synchronized with the source of the parameter collection, if any.

Error Safety: Can throw exceptions. Throws a System.ArgumentNullException if the key passed is null. Throws a System.NotSupportedException if writing the key passed is not supported.