IMVIORS232

IMVIORS232 Interface.

The IMVIORS232 Interface is used to setup the MV I/O RS232 Serial Port Filter. Read the filter description to see how the filter is used.

Header file: IMVIORS232.h
Interface definition language file: IMVIORS232.idl
Typelib: MVIORS232
Interface ID: IID_IMVIORS232

Method IMVIORS232::AddTimer

Declaration: Sub AddTimer(piTimerNumber As Long, szTimerName As String, szTimerDataString As String, iTimeOut As Long)

Add a timer.

Parameter:

	piTimerNumber	Return value: the number of the added timer.
	szTimerName	The Name of the Timer.
	szTimerDataString	The datastring of the timer. It depends on the current transfer mode, how this string is interpretated (ASCII or Hexadecimal).
	iTimeOut	The timeout value of this timer in milliseconds.

Prototype:

HRESULT AddTimer(LONG* piTimerNumber, BSTR szTimerName, BSTR szTimerDataString, LONG iTimeOut);

Property IMVIORS232::ComPort

Declaration: Property Get/Put ComPort As Long

RS232 Port which is used.

Prototype:

HRESULT put_ComPort(LONG);
HRESULT get_ComPort(LONG*);

Property IMVIORS232::ComPortSpeed

Declaration: Property Get/Put ComPortSpeed As Long

Comport speed.

Prototype:

HRESULT put_ComPortSpeed(LONG);
HRESULT get_ComPortSpeed(LONG*);

Method IMVIORS232::DeleteAllTimers

Declaration: Sub DeleteAllTimers

Delete all timers.

Prototype:

HRESULT DeleteAllTimers();

Method IMVIORS232::DeleteTimer

Declaration: Sub DeleteTimer(iTimerNumber As Long)

Delete a timer.

Parameter:

iTimerNumber

Timer to be deleted.

Prototype:

HRESULT DeleteTimer(LONG iTimerNumber);

Method IMVIORS232::GetPinDirection

Declaration: Sub GetPinDirection(pDirection As Long, iPinNumber As Long)

Get the direction of a pin.

Parameter:

	pDirection	Return value: pointer to a long value that receives the pin direction.
	iPinNumber	Pin number.

Prototype:

HRESULT GetPinDirection(LONG* pDirection, LONG iPinNumber);

Method IMVIORS232::GetPinMediaType

Declaration: Sub GetPinMediaType(SubMediaType As stdole.GUID, iPinNumber As Long)

Get the mediatype of a pin.

Parameter:

	SubMediaType	Return value: pointer to a GUID which receives the used SubMediaType.
	iPinNumber	Pin number.

Prototype:

HRESULT GetPinMediaType(GUID* SubMediaType, LONG iPinNumber);

Method IMVIORS232::GetPinName

Declaration: Sub GetPinName(szPinName As String, iPinNumber As Long)

Get the pin name.

Parameter:

	szPinName	Return value: pointer to a string (PinName).
	iPinNumber	Pin number.

Prototype:

HRESULT GetPinName(BSTR *szPinName, LONG iPinNumber);

Method IMVIORS232::GetPinPostfix

Declaration: Sub GetPinPostfix(szPinPostfix As String, iPinNumber As Long)

Get the postfix of a pin.

Parameter:

	szPinPostfix	Return value: pointer to a string (Postfix).
	iPinNumber	Pin number.

Prototype:

HRESULT GetPinPostfix(BSTR *szPinPostfix, LONG iPinNumber);

Method IMVIORS232::GetPinPrefix

Declaration: Sub GetPinPrefix(szPinPrefix As String, iPinNumber As Long)

Get the prefix of a pin.

Parameter:

	szPinPrefix	Return value: pointer to a string (Prefix).
	iPinNumber	Pin number.

Prototype:

HRESULT GetPinPrefix(BSTR *szPinPrefix, LONG iPinNumber);

Method IMVIORS232::GetTimerDataString

Declaration: Sub GetTimerDataString(szDataString As String, iTimerNumber As Long)

Get the data string value of the specified timer.

Parameter:

	szDataString	Return value: pointer to a string (DataString).
	iTimerNumber	Timer Number.

Prototype:

HRESULT GetTimerDataString(BSTR *szDataString, LONG iTimerNumber);

Method IMVIORS232::GetTimerName

Declaration: Sub GetTimerName(szTimerName As String, iTimerNumber As Long)

Get the name of a timer.

Parameter:

	szTimerName	Return value: pointer to a string (TimerName)
	iTimerNumber	Timer Number.

Prototype:

HRESULT GetTimerName(STRING szTimerName, LONG iTimerNumber);

Method IMVIORS232::GetTimerTimeout

Declaration: Sub GetTimerTimeout(piTimeout As Long, iTimerNumber As Long)

Get the timeout value of the specified timer.

Parameter:

	piTimeout	Return value: pointer to a long value that receives the timeout in milliseconds.
	iTimerNumber	Timer Number.

Prototype:

HRESULT GetTimerTimeout(LONG *piTimeout, LONG iTimerNumber);

Method IMVIORS232::IsPinConnected

Declaration: Sub IsPinConnected(pbConnected As Long, iPinNumber As Long)

Get the connection status of a pin.

Parameter:

	pbConnected	Return value: pointer to a BOOL value that receives the connection status (TRUE = connected).
	iPinNumber	Pin number.

Prototype:

HRESULT IsPinConnected(BOOL *pbConnected, LONG iPinNumber);

Property IMVIORS232::PauseString

Declaration: Property Get/Put PauseString As String

String which is sent when changing into PAUSE state.

Prototype:

HRESULT put_PauseString(BSTR);
HRESULT get_PauseString(BSTR*);

Property IMVIORS232::PinCount

Declaration: Property Get PinCount As Long

Get the amount of available pins. This is a read only property.

Prototype:

HRESULT get_PinCount(LONG*);

Method IMVIORS232::PutPinPostfix

Declaration: Sub PutPinPostfix(szPinPostfix As String, iPinNumber As Long)

Set the postfix of a pin.

Parameter:

	szPinPostfix	String that holds the postfix.
	iPinNumber	Pin number.

Prototype:

HRESULT PutPinPostfix(BSTR szPinPostfix, LONG iPinNumber);

Method IMVIORS232::PutPinPrefix

Declaration: Sub PutPinPrefix(szPinPrefix As String, iPinNumber As Long)

Set the prefix of a pin.

Parameter:

	szPinPrefix	String that holds the prefix.
	iPinNumber	Pin number.

Prototype:

HRESULT PutPinPrefix(BSTR szPinPrefix, LONG iPinNumber);

Method IMVIORS232::PutTimerName

Declaration: Sub PutTimerName(szTimerName As String, iTimerNumber As Long)

Set the name of a timer.

Parameter:

	szTimerName	String that holds the timer name.
	iTimerNumber	Timer number.

Prototype:

HRESULT PutTimerName(BSTR szTimerName, LONG iTimerNumber);

Property IMVIORS232::StartString

Declaration: Property Get/Put StartString As String

String which is sent when changing into RUNNING state.

Prototype:

HRESULT put_StartString(BSTR);
HRESULT get_StartString(BSTR*);

Property IMVIORS232::StopString

Declaration: Property Get/Put StopString As String

String which is sent when changing into STOP state.

Prototype:

HRESULT put_StopString(BSTR);
HRESULT get_StopString(BSTR*);

Property IMVIORS232::TimerCount

Declaration: Property Get TimerCount As Long

Get the amount of timers. This is a read only property.

Prototype:

HRESULT get_TimerCount(LONG*);

Property IMVIORS232::TransferMode

Declaration: Property Get/Put TransferMode As Long

RS232 transfer mode. See here.

Prototype:

HRESULT put_TransferMode(LONG);
HRESULT get_TransferMode(LONG*);

Filter specific structures and enumerators

typedef enum _MV_TRANSFER_MODE
{ 
    MV_TRANSFER_MODE_ASCII = 0,
    MV_TRANSFER_MODE_HEX   = MV_TRANSFER_MODE_ASCII + 1
}MV_TRANSFER_MODE;

DirectX specific structures

typedef enum _PinDirection
{ 
    PINDIR_INPUT  = 0,
    PINDIR_OUTPUT = PINDIR_INPUT + 1
}PIN_DIRECTION;