Inheritance diagram for CanEasy::IDatabaseItem:

Detailed Description

Base interface for all database items.

 
    interface IDatabaseItem : IDispatch
    {    
         HRESULT Name([out, retval] BSTR*);
         HRESULT Name([in] BSTR sNewVal);
 
         HRESULT Init();
         HRESULT Delete();
         HRESULT DeleteChildren();
         HRESULT DeleteProperties();
         HRESULT IsParent([in]IDatabaseItem* pItem, [out, retval] VARIANT_BOOL*);
 
         HRESULT Parent([out, retval] IDatabaseItem**);
         HRESULT Parent([in] IDatabaseItem* pItem);
 
         HRESULT Children([out, retval] IDatabaseItemCol**);
         HRESULT Attributes([out, retval] IAttrCol**);
         HRESULT Attribute([in] BSTR sName, [out, retval] IAttribute**);
         HRESULT Description([out, retval] IAttribute**);
         HRESULT Deleted([out, retval] VARIANT_BOOL*);
         HRESULT Visible([out, retval] VARIANT_BOOL*);
         HRESULT Visible([in] VARIANT_BOOL boVal);
         HRESULT StringRef([out, retval] BSTR*);
          HRESULT StringRef([in] BSTR val);
         HRESULT TypeString([out, retval] BSTR*);
         HRESULT Handle([out, retval] struct HandleDB*); //VSTAHidden
#ifdef _WIN64
         HRESULT Pointer([out, retval] LONG_PTR*); //VSTAHidden     /* FIXME_64Bit */
#else
         HRESULT Pointer([out, retval] long*); //VSTAHidden
#endif
         HRESULT UpdateReference([out, retval] VARIANT_BOOL*);
         HRESULT GetObjectByStringRef([in] BSTR sText, [out, retval] IDatabaseItem**);
         HRESULT Namespaces([out, retval] INamespaceCol**);
         HRESULT Color([out, retval] long*);
         HRESULT Color([in] long lColor);
         HRESULT Transmit([out, retval] VARIANT_BOOL* pResult);
         HRESULT Copy([out, retval] IDatabaseItem**);
         HRESULT TransmitOn([in] IBus* pBus, [out, retval] VARIANT_BOOL*);
         HRESULT WaitForTransmit([in] long timeout);
         HRESULT TransmissionState([out, retval] enum TransmissionState*);
         HRESULT TransmitAndWait([out, retval] VARIANT_BOOL*);
    };  
 

Definition at line 1332 of file cand_tlb.idl.

Member Function Documentation

◆ Copy()

HRESULT CanEasy::IDatabaseItem::Copy ( [out, retval] IDatabaseItem ** )

Creates a copy/clone of this and all containing children

◆ Delete()

HRESULT CanEasy::IDatabaseItem::Delete ( )

Deletes this database item

◆ DeleteChildren()

HRESULT CanEasy::IDatabaseItem::DeleteChildren ( )

Deletes all children of this database item

◆ DeleteProperties()

HRESULT CanEasy::IDatabaseItem::DeleteProperties ( )

Deletes all properties of this database item

◆ GetObjectByStringRef()

HRESULT CanEasy::IDatabaseItem::GetObjectByStringRef	(	[in] BSTR	sText,
		[out, retval] IDatabaseItem **
	)

Searches for a database item which is a child of this database item

Parameters

sText String reference (path) starting from the first child

Returns: Found database item

◆ Init()

HRESULT CanEasy::IDatabaseItem::Init ( )

Initializes new created database items

◆ IsParent()

HRESULT CanEasy::IDatabaseItem::IsParent	(	[in] IDatabaseItem *	pItem,
		[out, retval] VARIANT_BOOL *
	)

Returns true if passed database item is parent of this one

Parameters

pItem Pointer to database item

Returns: True if passed item is parent of this one

◆ Transmit()

HRESULT CanEasy::IDatabaseItem::Transmit ( [out, retval] VARIANT_BOOL * pResult )

Transmits this database item

Returns: Returns false if item was not able to transmit

◆ TransmitAndWait()

HRESULT CanEasy::IDatabaseItem::TransmitAndWait ( [out, retval] VARIANT_BOOL * )

Transmits this database item and waits for a response

◆ TransmitOn()

HRESULT CanEasy::IDatabaseItem::TransmitOn	(	[in] IBus *	pBus,
		[out, retval] VARIANT_BOOL *
	)

Transmits this database item on the passed channel

Parameters

pBus	Bus/Channel on which this item has to be transmitted

Returns: True if transmission was successfull

◆ UpdateReference()

HRESULT CanEasy::IDatabaseItem::UpdateReference ( [out, retval] VARIANT_BOOL * )

Check if there is a valid reference in the database

Returns: Returns True if the string reference (path) is valid

◆ WaitForTransmit()

HRESULT CanEasy::IDatabaseItem::WaitForTransmit ( [in] long timeout )

Waits till the transmission was completed

Property Documentation

◆ Attribute

IAttribute CanEasy::IDatabaseItem::Attribute([in] BSTR sName)

get

Returns an attribute by name.

If the attribute does not exist it gets created

Parameters

sName Name of the attribute

Returns: Pointer to attribute

◆ Attributes

IAttrCol CanEasy::IDatabaseItem::Attributes

get

Returns collection containing all attributes

◆ Children

IDatabaseItemCol CanEasy::IDatabaseItem::Children

get

Returns collection containing all children

◆ Color

long CanEasy::IDatabaseItem::Color

getset

Color of this database item

◆ Deleted

VARIANT_BOOL CanEasy::IDatabaseItem::Deleted

get

Returns true if this database item was already deleted

◆ Description

IAttribute CanEasy::IDatabaseItem::Description

get

Description of this database item

◆ Handle

HandleDB CanEasy::IDatabaseItem::Handle

get

Returns the internal handle for our C-API

◆ Name

BSTR CanEasy::IDatabaseItem::Name

getset

Name of database item

◆ Namespaces

INamespaceCol CanEasy::IDatabaseItem::Namespaces

get

Returns collection of namespaces

◆ Parent

IDatabaseItem CanEasy::IDatabaseItem::Parent

getset

Parent of this database item

◆ Pointer

long CanEasy::IDatabaseItem::Pointer

get

Returns the pointer to the internal C++ interface

◆ StringRef

BSTR CanEasy::IDatabaseItem::StringRef

getset

Returns the string reference (path) for this database item

Changes the internal database reference according to the passed string reference (path)

◆ TransmissionState

TransmissionState CanEasy::IDatabaseItem::TransmissionState

get

Returns the transmission state

◆ TypeString

BSTR CanEasy::IDatabaseItem::TypeString

get

Returns the type string of this database item which can be used to create this item

◆ Visible

VARIANT_BOOL CanEasy::IDatabaseItem::Visible

getset

True if this database item is visible in tree