CanEasy COM-Help
CanEasy::IPreTransmit Interface Reference

Inherits IDispatch.

Detailed Description

Provides PreTransmit events which are called before a message gets transmitted.

You can activate PreTransmit events for a database item or create an object of IPreTransmit

interface IPreTransmit : IDispatch
{
HRESULT Filter([in] BSTR sFilter, [in] BSTR sId, [in] enum CallbackPosition enPosition, [in] IDatabaseItem* pItem);
HRESULT Active([out, retval] VARIANT_BOOL* pVal);
HRESULT Active([in] VARIANT_BOOL boVal);
};

Definition at line 8085 of file cand_tlb.idl.

Member Function Documentation

◆ Filter()

HRESULT CanEasy::IPreTransmit::Filter ( [in] BSTR  sFilter,
[in] BSTR  sId,
[in] enum CallbackPosition  enPosition,
[in] IDatabaseItem pItem 
)

Sets a filter to reduce the events.

See TransmissionEvent to get more details

Parameters
sFilterString filter
sIdUnique identifier name
enPositionDeprecated: Position when event is called
pItemPointer to database item for which the event must be registered

Property Documentation

◆ Active

VARIANT_BOOL CanEasy::IPreTransmit::Active
getset

Activates/Deactivates the events

CanEasy::IPreTransmit::Active
VARIANT_BOOL Active
CanEasy::IPreTransmit::Filter
HRESULT Filter([in] BSTR sFilter, [in] BSTR sId, [in] enum CallbackPosition enPosition, [in] IDatabaseItem *pItem)
Sets a filter to reduce the events.
CanEasy::CallbackPosition
CallbackPosition
Deprecated: The CallbackPosition enumeration defines the position when a transmission callback has to...
Definition: cand_tlb.idl:289