Define a CSV file record source.


Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)

Syntax

Visual Basic (Declaration)
Public Sub New( _ 
   ByVal fileName As String,  _ 
   ByVal encoding As String,  _ 
   ByVal doMaxWork As Boolean,  _ 
   ByVal leadingKey As Boolean,  _ 
   ByVal initialKey As Integer,  _ 
   ByVal fieldNamesFirst As Boolean,  _ 
   ByVal fieldTypesFirst As Boolean,  _ 
   ByVal keyIndex As Integer,  _ 
   ByVal keyName As String _ 
)
C#
public NetricsRecFile(
   string fileName,
   string encoding,
   bool doMaxWork,
   bool leadingKey,
   int initialKey,
   bool fieldNamesFirst,
   bool fieldTypesFirst,
   int keyIndex,
   string keyName
)
C++
public:
 NetricsRecFile(
   String fileName,
   String encoding,
   bool doMaxWork,
   bool leadingKey,
   int initialKey,
   bool fieldNamesFirst,
   bool fieldTypesFirst,
   int keyIndex,
   String keyName
) sealed 
J#
public NetricsRecFile(
   string fileName,
   string encoding,
   bool doMaxWork,
   bool leadingKey,
   int initialKey,
   bool fieldNamesFirst,
   bool fieldTypesFirst,
   int keyIndex,
   string keyName
)
JScript
public function NetricsRecFile(
   fileName : String,
   encoding : String,
   doMaxWork : bool,
   leadingKey : bool,
   initialKey : int,
   fieldNamesFirst : bool,
   fieldTypesFirst : bool,
   keyIndex : int,
   keyName : String
)

Parameters

fileName
The name of the file containing the records.
encoding
This defines the character encoding used in the file. Currently supported encodings are: "UTF-8" or "LATIN1". DEFAULT: "LATIN1"
doMaxWork
Ignore badly formatted records.
leadingKey
This parameter is true if the file has the Leading Key format.
initialKey
If the No Key format is used this defines the initial key value for the generated keys. If this is less than 0 the default value of 0 is used. Keys are sequential numbers starting at the initial key.
fieldNamesFirst
If true the field names header line is present in the file.
fieldTypesFirst
If true the field types header line is present in the file.
keyIndex
If this is non-negative it defines the index (0 based) of the key field in the file records.
keyName
If this is non-null it defines the name of the key field in the file records and the file must contain a field names header record and fieldNamesFirst must be true.

Exceptions

Exception TypeCondition
NetricsExceptionIf an invalid or illegal combination of values is given.

See Also

Syntax based on .NET Framework version 2.0.
Documentation version 1.0.0.0.