Cross Point


IXMLBase Interface Reference

Inheritance diagram for IXMLBase:

IEventBase IEvent IEventDatabase IParameter IParameterDatabase IProximityReader ITimeBlock ITimeScheme IUser IUserDatabase IUserGroup List of all members.

Detailed Description

Base interface for all objects that support writing to and reading from file.

This base interface contains functionality to generate XML of this object, it can generate typed or untyped XML of this object. This interface can also be used to initialize this object using XML.

The main functionality however is to Upload an XML or CSV file into this object and to Download the data contained in this object to file.

See the detailed sections of the methods/properties for more information.


Public Member Functions

HRESULT XMLDomElement ([out, retval] IDispatch **ppintfXMLElement)
 Returns the data of this object in an XML DOM element.

HRESULT XMLDomElementTyped ([out, retval] IDispatch **ppintfXMLElement)
 Returns a typed XML DOM element of this object/.

HRESULT XMLDomElement ([in] IDispatch *pintfXMLElement)
 Set all data of this object.

HRESULT Download ([in] BSTR Filename,[in] EFileType EFileType)
 Saves all data of this object in an XML or CSV file.

HRESULT Upload ([in] BSTR Filename,[in] EFileType EFileType,[in] EUploadOptions Options,[in, defaultvalue(0)] VARIANT_BOOL UploadAsync)
 Loads all object data from the specified file into this object.

HRESULT UploadXMLDomElement ([in] IDispatch *pintfXMLElement,[in] EUploadOptions Options,[in, defaultvalue(0)] VARIANT_BOOL UploadAsync)
 Loads all object data from a DOM Document into this object.


Member Function Documentation

IXMLBase::XMLDomElement [out, retval] IDispatch **  ppintfXMLElement  ) 
 

Returns the data of this object in an XML DOM element.

This method returns the data of this object in an XML DOM element, no type information will be included. If you want XML as a string, use the 'xml' property of the returned XML Element.

Parameters:
ppintfXMLElement The XML Element in which the data is returned.
Precondition:
ppintfXMLElement is not NULL.
See also:
XMLDomElementTyped

IXMLBase::XMLDomElementTyped [out, retval] IDispatch **  ppintfXMLElement  ) 
 

Returns a typed XML DOM element of this object/.

This property returns the data of this object in an XML DOM element, all data elements will include type information. If you want XML as a string, use the 'xml' property of the returned XML Element.

Parameters:
ppintfXMLElement The XML Element in which the data is returned.
Precondition:
ppintfXMLElement is not NULL.
Note:
This is a read-only property when used in scripting languages.
See also:
XMLDomElement

IXMLBase::XMLDomElement [in] IDispatch *  pintfXMLElement  ) 
 

Set all data of this object.

All data of this object will be set to the data supplied in the XML Element (if it contains valid data). This property can be used to copy information from, for instance, one reader to another reader. An easier method of copying data from one reader to another reader is to use the IProximityReader::CopyFrom method.

Parameters:
pintfXMLElement The XML Element with data for this object.
Precondition:
pintfXMLElement is not NULL.
Note:
The RFID interface will be disabled during this process.
See also:
XMLDomElementTyped

IXMLBase::Download [in] BSTR  bstrFilename,
[in] EFileType  eFileType
 

Saves all data of this object in an XML or CSV file.

Stores all data of this object in a file. The data can be saved to either and XML file or to an .CSV file (Comma-Separated Values). Saving to a .CSV file is only supported for the userdatabase object.

Parameters:
bstrFilename The file name of the file in which the data should be saved.
eFileType The data will be saved in the format specified in this argument.
See also:
Upload, EFileType

IXMLBase::Upload [in] BSTR  bstrFilename,
[in] EFileType  eFileType,
[in] EUploadOptions  eOptions,
[in, defaultvalue(0)] VARIANT_BOOL  fUploadAsync
 

Loads all object data from the specified file into this object.

This method can for instance be used to upload an entire file of users into a reader.

Events of processtype ptUploading are fired by this method, no progress events will be fired. If the uoClearUserDatabase flag is specified in the options, the IUserDatabase::Clear method will be called to clear the userdatabase. Check the documentation of that Clear method to see what events are generated on the userdatabase object. Depending on what other information is stored in the file, other events will be fired.

  • When there are users in the file, events of processtype ptSettingUsers are fired, see IUserDatabase::Users for more information. Note that if this object is the userdatabse, those events will be fired as sub processes of the ptUploading process.
  • If there are parameters in the file, see the IParameterDatabase::Parameters property for more information about the fired events.
  • If holidays are stored in the file, refer to the IProximityReader::AddHolidays for the fired events.
If there are parameters in the file, but the current object is for instance the userdatabase, those parameters will be skipped, they cannot be set on the userdatabase. Uploading the file with the parameters on the reader object will succeed, as well as of course uploading the file on the parameterdatabase object.

Parameters:
bstrFilename The filename of the file with data in XML or CSV format.
eFileType Type of the file.
eOptions The different upload options, see EUploadOptions for more information.
fUploadAsync If set to true, the entire upload process is done async (in the background).
Note:
The RFID interface will be disabled during this process.
See also:
Download, UploadXMLDomElement

IXMLBase::UploadXMLDomElement [in] IDispatch *  pintfXMLElement,
[in] EUploadOptions  eOptions,
[in, defaultvalue(0)] VARIANT_BOOL  fUploadAsync
 

Loads all object data from a DOM Document into this object.

This method can for instance be used to upload a DOM document into a reader. This method will fire the same events as the Upload method, refer to the Upload method documentation for more information.

Parameters:
pintfXMLElement A pointer to the DOM Document Root Element containg the data.
eOptions The different upload options, see EUploadOptions for more information.
fUploadAsync If set to true, the entire upload process is done async (in the background).
Note:
The RFID interface will be disabled during this process.
See also:
Download, Upload


© Copyright 2001 - 2006 Cross Point. Generated on Mon Mar 12 16:29:52 2007 Cross Point