HL7PlusFileInfo

Exists

Boolean

Evaluates whether FileName exists or not.

FileExtension

String

The file extension for FileName

FileLastModified

Date

The LastWriteTime value FileName if it does not exist then current date/time is returned.

FileName

String

The full path / filename the object should act upon.

FilePath

String

The folder portion of FileName is located with trailing backslash.

FileTitle

String

The File Title portion of FileName including the FileExtension.

FileTitleNoExtension

String

The File Title portion of FileName without the FileExtension.

Index

Integer

A general purpose Index Integer for your use.

IntegerTag

Integer

A general purpose Integer Tag value for your use.

IsHidden

Boolean

Indicates whether FileName is flagged as HIDDEN.

IsReadOnly

Boolean

Indicates whether FileName is flagged as READ-ONLY.

IsSystem

Boolean

Indicates whether FileName is flagged as a Windows SYSTEM file.

Key

String

A general purpose String Key value for your use.

LastAnalysisError

EHFA_ErrorType

The object uses an internal HL7PlusFileAnalyzer object for restricted methods. This is the last analysis error ENUM from one of those method calls.

Tag

String

A general purpose String Tag value for your use.

Method:

CopyToFile(obFileInformation, blnOverwriteIfExists = False) + 1 overload

CopyToFile(strFileName, blnOverWriteIfExists)

Paramters:

1: obFileInformation (HL7PlusFileInfo) HL7PlusFileInfo object where obFileInformation.Filename is the path/filename to copy FileName TO

1: strFileName (String) the path/filename to copy FileName TO

2: blnOverWriteIfExists (Boolean) OPTIONAL should the destination file name (strFileName or obFileInformation.FileName) be overwritten if it already exists.

Return Value:

Boolean Success or Failure

Description:

Copies FileName to another file.

Method:

CopyToFolder(obFolderInformation, blnOverwriteIfExists = False) + 1 overload

CopyToFolder(strFolderToCopyTo, blnOverWriteIfExists = False)

Paramters:

1: obFileInformation (HL7PlusFolderInfo) HL7PlusFolderInfo object where obFolderInformation.FolderPath is the path to copy FileName TO

1: strFolderToCopyTo (String) the path to copy FileName TO

2: blnOverWriteIfExists (Boolean) OPTIONAL should the destination file name (strFileName or obFileInformation.FileName) be overwritten if it already exists.

Return Value:

Boolean Success or Failure

Description:

Copies FileName to another folder keeping the same FileTitle.

Method:

CountHL7PlusMessagesInFile(oController)

Paramters:

1: oController (HL7PlusFolderInfo) HL7PlusController object

NOTE: This is a restricted method which means that oController.IsRunnable must be TRUE or the method will fail and LastError will be set to True.

Return Value:

Integer

Description:

Counts the number of HL7 messages in FileName. Will return 0 if there are no messages in the file OR if an error occurs.

NOTE: This method uses an internal HL7PlusFileAnalyzer object so you can also query LastAnalysisError after each call to this method.

NOTE: For long file operations (IE files with many HL7 messages) the Working Event is fired frequently and the operation can be cancelled.

Method:

DeleteFile()

Paramters:

None

Return Value:

Boolean Success or Failure

Description:

Attempts to permanently delete FileName.

Method:

GetHL7PlusMessages(oController)

Paramters:

1: oController (HL7PlusFolderInfo) HL7PlusController object

NOTE: This is a restricted method which means that oController.IsRunnable must be TRUE or the method will fail and LastError will be set to True.

Return Value:

List(of HL7PlusMessage)

Description:

Retrieves a standard .Net List object containing HL7PlusMessage objects for each message in FileName. If there none or an error occurs an empty List is returned.

NOTE: This method uses an internal HL7PlusFileAnalyzer object so you can also query LastAnalysisError after each call to this method.

NOTE: For long file operations (IE files with many HL7 messages) the Working Event is fired frequently and the operation can be cancelled.

Method:

GetHL7PlusMessageStrings(oController)

Paramters:

1: oController (HL7PlusFolderInfo) HL7PlusController object

NOTE: This is a restricted method which means that oController.IsRunnable must be TRUE or the method will fail and LastError will be set to True.

Return Value:

List(of String)

Description:

Retrieves a standard .Net List object containing each HL7 message (String) in FileName. If there none or an error occurs an empty List is returned.

NOTE: This method uses an internal HL7PlusFileAnalyzer object so you can also query LastAnalysisError after each call to this method.

NOTE: For long file operations (IE files with many HL7 messages) the Working Event is fired frequently and the operation can be cancelled.

Event:

Working (strFileName, blnCancel)

Paramters:

1: strFileName (String) FileName.

2: blnCancel (Boolean) Initial Value = False- Do you want to cancel the operation

Condition:

This event is fired frequently if you call any of the HL7 analysis methods like CountHL7MessagesInFile(), or GetHL7Messages(), or GetHL7MessageStrings(). You might need to work with this event if you think you will be working with very large HL7 data files.