InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDataUpdaterSuite Class Referenceabstract

#include <IDataUpdaterSuite.h>

Inheritance diagram for IDataUpdaterSuite:
IPMUnknownCPMUnknown< IDataUpdaterSuite >DataUpdaterSuiteASBDataUpdaterSuiteTextCSB

Public Types

enum  { kDefaultIID = IID_IDATAUPDATERSUITE }
 

Public Member Functions

virtual bool16 CanInsertData () const =0
 
virtual ErrorCode InsertData (const WideString &table, const WideString &record, const WideString &field, const WideString &value)=0
 
virtual ErrorCode InsertAllData (const IDFile &file)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

From SDK sample; Abstract suite interface for XMLDataUpdater data tag manipulation.

Member Function Documentation

virtual bool16 IDataUpdaterSuite::CanInsertData () const
pure virtual

Check if data can be inserted at the position.

Returns
kTrue if tag can be inserted, other ErrorCode otherwise.

Implemented in DataUpdaterSuiteTextCSB, and DataUpdaterSuiteASB.

virtual ErrorCode IDataUpdaterSuite::InsertAllData (const IDFilefile)
pure virtual

Insert every value in the given CSV file.

Precondition
IDataUpdaterSuite::CanInsertData returns kTrue
Parameters
file
Returns
kSuccess on success, other ErrorCode otherwise.

Implemented in DataUpdaterSuiteTextCSB, and DataUpdaterSuiteASB.

virtual ErrorCode IDataUpdaterSuite::InsertData (const WideStringtable,
const WideStringrecord,
const WideStringfield,
const WideStringvalue 
)
pure virtual

Insert data.

Precondition
IDataUpdaterSuite::CanInsertData returns kTrue
Parameters
tableIN the table name for the data.
recordIN the key string (that identifies the record) for the data.
fieldIN the field name for the data.
valueIN the value of the data.
Returns
kSuccess if tag inserted, other ErrorCode otherwise.

Implemented in DataUpdaterSuiteTextCSB, and DataUpdaterSuiteASB.