BeccExcelBook Class Reference

Public Member Functions
public	BeccExcelBook ()
public int	load (string sFilePath)
public shared_ptr< BeccExcelSheet >	getSheet (int iSheetIndex)
public int	getSheetCount ()
public int	getSheetIndex (string sSheetName)
public dyn_string	getSheetNames ()

Static Public Member Functions
static public mapping	getVersionInfo ()

Detailed Description

Represents a excel book

Constructor & Destructor Documentation

BeccExcelBook()

public BeccExcelBook::BeccExcelBook ( )

inline

Constructor

Member Function Documentation

getSheet()

public shared_ptr<BeccExcelSheet> BeccExcelBook::getSheet ( int  iSheetIndex )

inline

Get all sheets of the excel book

Returns

Pointer array of sheets (shared_ptr<BeccExcelSheet>) of the excel book
Get the sheet of the given sheet index

Parameters

iSheetIndex

... sheet index

Returns

return the sheet of the given index

getSheetCount()

public int BeccExcelBook::getSheetCount ( )

inline

Get sheet count of the excel book

Returns

return the sheet count

getSheetIndex()

public int BeccExcelBook::getSheetIndex ( string  sSheetName )

inline

Get the sheet index of the given sheet name

Parameters

sSheetName

... sheet name

Returns

return the sheet index of the given sheet name. If sheetname not found return -1

getSheetNames()

public dyn_string BeccExcelBook::getSheetNames ( )

inline

Get sheet names of the excel book

Returns

return the sheet names

getVersionInfo()

static public mapping BeccExcelBook::getVersionInfo ( )

inlinestatic

Get version information

Returns

load()

public int BeccExcelBook::load ( string  sFilePath )

inline

Loads the excel file into memory

Parameters

sFilePath

... Full path of excel file

Returns

0 ... no error -1 ... file does not exists or file could not be read