KeePass MSWifiPlugin
MSWifiImportPlugin.AbstractData Class Referenceabstract

Each Data is safed in a AbstractData as they can be safed in a XML-file or in a Database and therefore does not only contain its value and its name in a XML-file but also a name in the database More...

Inherits IXmlSerializable.

Inherited by MSWifiImportPlugin.Data< T >, and MSWifiImportPlugin.DataData< T >.

Public Member Functions

abstract void WriteXml (XmlWriter writer)
 Writes the data to a XML-file More...
 
abstract void ReadXml (XmlReader reader)
 Reads the data from a XML-file More...
 
XmlSchema GetSchema ()
 Always null More...
 
abstract bool ExistsIn (PwDatabase db, PwEntry entry)
 Checks whether the data is contained in a given entry More...
 
abstract bool SaveIn (PwDatabase db, PwEntry entry)
 Writes a data to a given enty in a database More...
 
abstract bool LoadFrom (PwDatabase db, PwEntry entry)
 Reads a data from a given enty in a database More...
 
abstract void ClearIn (PwDatabase db, PwEntry entry)
 Deletes the data from a given enty in a database More...
 
abstract void Clear ()
 Clears the data More...
 

Protected Member Functions

 AbstractData (String eName, bool eIsMandory)
 Standard constructor More...
 

Properties

bool IsMandory [get, set]
 If this is true and this is invalid, then its parent is invalid, too. More...
 
String EntryName [get, set]
 Name of the value in the database More...
 
abstract bool WriteNecessary [get]
 Whether the value must be written in the XML-file, i.e. its valid but not empty. More...
 
abstract bool IsValid [get]
 Whether the data is valid, i.e. all mandory subentries have to valid. More...
 

Detailed Description

Each Data is safed in a AbstractData as they can be safed in a XML-file or in a Database and therefore does not only contain its value and its name in a XML-file but also a name in the database

Constructor & Destructor Documentation

◆ AbstractData()

MSWifiImportPlugin.AbstractData.AbstractData ( String  eName,
bool  eIsMandory 
)
protected

Standard constructor

Parameters
eNameName of the value in the database
eIsMandoryWhether the datas parent is only valid if the data is valid.

Member Function Documentation

◆ Clear()

abstract void MSWifiImportPlugin.AbstractData.Clear ( )
pure virtual

◆ ClearIn()

abstract void MSWifiImportPlugin.AbstractData.ClearIn ( PwDatabase  db,
PwEntry  entry 
)
pure virtual

Deletes the data from a given enty in a database

Parameters
dbThe database in which the entry is safed
entryThe entry from which the data will be removed.

Implemented in MSWifiImportPlugin.DataData< T >, MSWifiImportPlugin.Data< T >, and MSWifiImportPlugin.Data< T >.

◆ ExistsIn()

abstract bool MSWifiImportPlugin.AbstractData.ExistsIn ( PwDatabase  db,
PwEntry  entry 
)
pure virtual

Checks whether the data is contained in a given entry

Parameters
dbThe database in which the entry is safed
entryThe entry in which the data is (or isn't) safed.
Returns
Whether the data is contained in a given entry.

Implemented in MSWifiImportPlugin.DataData< T >, MSWifiImportPlugin.Data< T >, MSWifiImportPlugin.WlanProfile.MSMData.SecurityData.AuthEncryptionData, MSWifiImportPlugin.WlanProfile.MSMData.SecurityData, MSWifiImportPlugin.WlanProfile.MSMData, MSWifiImportPlugin.WlanProfile.SSIDConfigData.SSIDData< T >, and MSWifiImportPlugin.WlanProfile.SSIDConfigData.

◆ GetSchema()

XmlSchema MSWifiImportPlugin.AbstractData.GetSchema ( )

Always null

◆ LoadFrom()

abstract bool MSWifiImportPlugin.AbstractData.LoadFrom ( PwDatabase  db,
PwEntry  entry 
)
pure virtual

Reads a data from a given enty in a database

Parameters
dbThe database in which the entry is safed
entryThe entry in which the data was saved.
Returns
Whether the data is successfully loaded.

Implemented in MSWifiImportPlugin.DataData< T >, MSWifiImportPlugin.Data< T >, and MSWifiImportPlugin.Data< T >.

◆ ReadXml()

abstract void MSWifiImportPlugin.AbstractData.ReadXml ( XmlReader  reader)
pure virtual

Reads the data from a XML-file

Parameters
writerThe corresponding reader

Implemented in MSWifiImportPlugin.DataData< T >, MSWifiImportPlugin.Data< T >, and MSWifiImportPlugin.Data< T >.

◆ SaveIn()

abstract bool MSWifiImportPlugin.AbstractData.SaveIn ( PwDatabase  db,
PwEntry  entry 
)
pure virtual

Writes a data to a given enty in a database

Parameters
dbThe database in which the entry is safed
entryThe entry in which the data will be safed.
Returns
Whether the data is successfully saved.

Implemented in MSWifiImportPlugin.DataData< T >, MSWifiImportPlugin.Data< T >, and MSWifiImportPlugin.Data< T >.

◆ WriteXml()

abstract void MSWifiImportPlugin.AbstractData.WriteXml ( XmlWriter  writer)
pure virtual

Writes the data to a XML-file

Parameters
writerThe corresponding writer

Implemented in MSWifiImportPlugin.DataData< T >, MSWifiImportPlugin.Data< T >, and MSWifiImportPlugin.Data< T >.

Property Documentation

◆ EntryName

String MSWifiImportPlugin.AbstractData.EntryName
getset

Name of the value in the database

◆ IsMandory

bool MSWifiImportPlugin.AbstractData.IsMandory
getset

If this is true and this is invalid, then its parent is invalid, too.

◆ IsValid

abstract bool MSWifiImportPlugin.AbstractData.IsValid
get

Whether the data is valid, i.e. all mandory subentries have to valid.

Returns
Whether it is valid

◆ WriteNecessary

abstract bool MSWifiImportPlugin.AbstractData.WriteNecessary
get

Whether the value must be written in the XML-file, i.e. its valid but not empty.

Returns
Whether it is necessary.

The documentation for this class was generated from the following file: