ParameterValueLookUpGetCriteriaString Method

Builds and retrieves a string to be used as search criteria with the ParameterValueLookUp method.

Definition

Namespace: Peak.Can.Basic
Assembly: PCANBasic.NET (in PCANBasic.NET.dll) Version: 5.1.0
C#
public static string GetCriteriaString(
	PcanDevice? deviceType,
	uint? deviceId,
	uint? controllerNumber,
	string ipAddress,
	string deviceGuid
)

Parameters

deviceType  NullablePcanDevice
The type of device to match. It should be set to null in case the device type is not wanted as search criteria.
deviceId  NullableUInt32
The device ID to match. It should be set to null in case the device ID is not wanted as search criteria.
controllerNumber  NullableUInt32
The controller number to match. It should be set to null in case the controller number is not wanted as search criteria.
ipAddress  String
The IP address to match. It should be set to null in case the IP address is not wanted as search criteria.
deviceGuid  String
The global unique identifier (GUID) to match. It should be set to null in case the GUID is not wanted as search criteria.

Return Value

String
A formatted string containing the search parameters.

Example

To see an example of this method, please refer to the example of the LookUpChannel method.

Exceptions

PcanBasicExceptionThe current operation ended with an unexpected result. Check the inner exception for more information.

See Also