PCANBasicGetValue(UInt16, TPCANParameter, StringBuilder, UInt32) Method

public static TPCANStatus GetValue(
	ushort Channel,
	TPCANParameter Parameter,
	StringBuilder StringBuffer,
	uint BufferLength
)

Public Shared Function GetValue ( 
	Channel As UShort,
	Parameter As TPCANParameter,
	StringBuffer As StringBuilder,
	BufferLength As UInteger
) As TPCANStatus

public:
static TPCANStatus GetValue(
	unsigned short Channel, 
	TPCANParameter Parameter, 
	StringBuilder^ StringBuffer, 
	unsigned int BufferLength
)

Parameters

Channel  UInt16

The handle of a PCAN Channel (see PCAN Handle Definitions).

Parameter  TPCANParameter

The code of the information to be retrieved.

StringBuffer  StringBuilder

The buffer to return the required string value.

BufferLength  UInt32

The length in bytes of the given buffer.

Return Value

The return value is a TPCANStatus value. PCAN_ERROR_OK is returned on success. The typical errors in case of failure are:

• PCAN_ERROR_INITIALIZE: Indicates that the given PCAN channel was not found in the list of initialized channels of the calling application.
• PCAN_ERROR_ILLPARAMVAL: Indicates that one or more parameters passed to the method are invalid.
• PCAN_ERROR_ILLHW: Indicates that the given PCAN Channel is not available.
• PCAN_ERROR_ILLHANDLE: Indicates that the given PCAN Channel is not valid.
• PCAN_ERROR_ILLPARAMTYPE: Indicates that the requested information is not available for the given PCAN Channel. Check the value of Parameter; some values are not available for all PCAN-Channels or cannot be read.

Use the method GetValue to get information about PCAN environment as parameters like the API version. Take in account that not all parameters are supported for all PCAN Channels. The access's type of the parameters can also be different.

For more information about the possible values that can be retrieved, see Parameter Value Definitions

The following example shows the use of GetValue(UInt16, TPCANParameter, StringBuilder, UInt32) method on the channel PCAN_USBBUS1 to get the PCAN Channel version text. In case of failure, the returned code will be translated to a text (according with the operating system language) in English, German, Italian, French or Spanish, and it will be shown to the user.

TPCANStatus result;
System.Text.StringBuilder strMsg;

strMsg = new System.Text.StringBuilder(256);

// The version of the PCAN-USB Channel 1 is asked.
//
result = PCANBasic.GetValue(PCANBasic.PCAN_USBBUS1, TPCANParameter.PCAN_CHANNEL_VERSION, strMsg, 256);
if (result != TPCANStatus.PCAN_ERROR_OK)
{
    // An error occurred, get a text describing the error and show it
    //
    PCANBasic.GetErrorText(result, 0, strMsg);
    Console.WriteLine(strMsg.ToString());
}
else
{
    // Show the version message
    //
    Console.WriteLine(strMsg.ToString());
}

Dim result As TPCANStatus
Dim strMsg As System.Text.StringBuilder

strMsg = New System.Text.StringBuilder(256)

' The version of the PCAN-USB Channel 1 is asked.
'
result = PCANBasic.GetValue(PCANBasic.PCAN_USBBUS1, TPCANParameter.PCAN_CHANNEL_VERSION, strMsg, 256)
If result <> TPCANStatus.PCAN_ERROR_OK Then
    ' An error occurred, get a text describing the error and show it
    '
    PCANBasic.GetErrorText(result, 0, strMsg)
    Console.WriteLine(strMsg.ToString())
Else
    ' Show the version message
    '
    Console.WriteLine(strMsg.ToString())
End If

TPCANStatus result;
System::Text::StringBuilder^ strMsg;

strMsg = gcnew System::Text::StringBuilder(256);

// The version of the PCAN-USB Channel 1 is asked.
//
result = PCANBasic::GetValue(PCANBasic::PCAN_USBBUS1, TPCANParameter::PCAN_CHANNEL_VERSION, strMsg, 256);
if (result != TPCANStatus::PCAN_ERROR_OK)
{
    // An error occurred, get a text describing the error and show it
    //
    PCANBasic::GetErrorText(result, 0, strMsg);
    Console::WriteLine(strMsg->ToString());
}
else
{
    // Show the version message
    //
    Console::WriteLine(strMsg->ToString());
}

Reference

Other Resources