RVC::DBTABLE::LINKPARMS Class Reference

Parameters to link to external database tables. More...

#include <rvc/dbtable.h>

List of all members.

Public Types
enum	LINKFLAG { LINKFLAG_None = 0, LINKFLAG_KeepPassword = 0x00800000 }
Public Member Functions
	LINKPARMS (const MISTRING &LinkString, DBTABLE::LINKTYPE LinkType, CHAR_ENCODING Encoding, LINKFLAG LinkFlag=LINKFLAG_None, char Delimiter= ',')
	LINKPARMS (const FILEPATH &filepath, DBTABLE::LINKTYPE LinkType, CHAR_ENCODING Encoding, LINKFLAG LinkFlag=LINKFLAG_None, char Delimiter= ',')
	~LINKPARMS ()
char	GetDelimiter () const
CHAR_ENCODING	GetEncoding () const
LINKFLAG	GetLinkFlag () const
const MISTRING &	GetLinkString () const
DBTABLE::LINKTYPE	GetLinkType () const

---

Detailed Description

Parameters to link to external database tables.

---

Member Enumeration Documentation

enum RVC::DBTABLE::LINKPARMS::LINKFLAG

Link flags.

Enumerator:

LINKFLAG_None
LINKFLAG_KeepPassword

---

Constructor & Destructor Documentation

RVC::DBTABLE::LINKPARMS::LINKPARMS	(	const FILEPATH &	filepath,
		DBTABLE::LINKTYPE	LinkType,
		CHAR_ENCODING	Encoding,
		LINKFLAG	LinkFlag = LINKFLAG_None,
		char	Delimiter = ','
	)

Construct with FILEPATH.

Parameters:

	filepath	Local file path
	LinkType	Link type
	Encoding	External table character encoding
	LinkFlag	Flags if needed
	Delimiter	Field delimiter for CSV and similar

RVC::DBTABLE::LINKPARMS::LINKPARMS	(	const MISTRING &	LinkString,
		DBTABLE::LINKTYPE	LinkType,
		CHAR_ENCODING	Encoding,
		LINKFLAG	LinkFlag = LINKFLAG_None,
		char	Delimiter = ','
	)

Construct with link string.

Parameters:

	LinkString	Link string, for RDBMS must include separate 'TABLE=' to identify table being linked to
	LinkType	Link type
	Encoding	External table character encoding
	LinkFlag	Flags if needed
	Delimiter	Field delimiter for CSV and similar

RVC::DBTABLE::LINKPARMS::~LINKPARMS

(

)

Destructor.

---

Member Function Documentation

char RVC::DBTABLE::LINKPARMS::GetDelimiter

(

)

const [inline]

CHAR_ENCODING RVC::DBTABLE::LINKPARMS::GetEncoding

(

)

const [inline]

Get the encoding of the external table.

LINKFLAG RVC::DBTABLE::LINKPARMS::GetLinkFlag

(

)

const [inline]

const MISTRING& RVC::DBTABLE::LINKPARMS::GetLinkString

(

)

const [inline]

DBTABLE::LINKTYPE RVC::DBTABLE::LINKPARMS::GetLinkType

(

)

const [inline]

Get the type of external link.

Returns:

External link type

---

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

• rvc/dbtable.h