ImportDevicesExcel Method

In This Topic

This function imports devices from an Excel file into a given project.

Syntax

C#
C++/CLI

public StorableObject[] ImportDevicesExcel( 
   Project oProject,
   string strImportFilePath,
   string strSchemeName,
   string strTableName,
   int nHeadLinePos,
   int nHeadLineCount,
   FunctionDefinition oFuncDef,
   FunctionDefinition oTermFuncDef,
   DeviceService.ImportMode eMode
)

public:
array<StorableObject^>^ ImportDevicesExcel( 
   Project^ oProject,
   String^ strImportFilePath,
   String^ strSchemeName,
   String^ strTableName,
   int nHeadLinePos,
   int nHeadLineCount,
   FunctionDefinition^ oFuncDef,
   FunctionDefinition^ oTermFuncDef,
   DeviceService.ImportMode eMode
)

Parameters

oProject: Project into which the devices will be imported.
strImportFilePath: Full file name of the devices file to import.
strSchemeName: Name of the import scheme. If the scheme name is empty the last used scheme of the project will be used.
strTableName: Excel sheet name.
nHeadLinePos: The position of the head line that will be used to asssign the column values at the import.
nHeadLineCount: The count of head lines that will be skipped at the import.
oFuncDef: Default Function Definition
oTermFuncDef: Default Terminal Function Definition
eMode: The import mode can be a combination of the XPProcImportMode enum and controls the import action (in)(optional) eCreateMode = 1: The import create only missing device tags eChangeMode = 2: The import change only existing device tags eDeleteMode = 4: The import delete only unnecessary existing device tags

Return Value

Result is returned as array of StorableObjects.

Exceptions

Exception	Description
ArgumentException	Invalid parameters found.
ArgumentNullException	Null was passed to a parameter.
ApplicationException	The internal interface for importing devices could not be created.
BaseException	An error occurred during the import of devices. Please refer to the exception message.

Remarks

If new schema is not present old import method is used

Reference

DeviceService Class
DeviceService Members

Send Feedback