HL7PlusFolderInfo

*All example code is in Visual Basic.Net

Dim fInfo As New HL7PlusFolderInfo("C:\HL7Data")

Dim oL1 As List(Of HL7PlusFolderInfo) = fInfo.ChildFolders

MessageBox.Show(fInfo.FolderPath & " has " & oL1.Count.ToString & " Sub-folders")

With fInfo

.IgnoreReadOnlyFiles = True 'This is FALSE by default

.IgnoreHiddenFiles = True 'It was True by default

.IgnoreSystemFiles = True 'It was True by default

.IgnoreZeroByteFiles = True 'This is FALSE by default

' I only want files that are AT LEAST 1 second old

.MinimumFileAge = 1

'The default sort is by Last Modified Date but

'I want my list to be in File Name order

.ResultSortOrder = HL7PlusFolderInfo.FolderPollResultSortOrder.enFileName

'----Now Get Some Files Out of the Folder

Dim oFIles As List(Of HL7PlusFileInfo)

'If I want a list of all of the files in the folder

oFIles = .PollFolderForFiles()

'If I want to see only HL7 files.

oFIles = .PollFolderForFiles("hl7")

'If I want a list of *.HL7, *.TXT, and *.DAT files

Dim oExtensions As New List(Of String)

With oExtensions

.Add("hl7")

.Add("TXT") 'It is not case-sensitive

.Add("Dat")

End With

oFIles = .PollFolderForFiles(oExtensions)

If fInfo.IsError Then

MessageBox.Show("An error occurred: " & .LastError, "Error")

Return

End If

If oFIles.Count = 0 Then

MessageBox.Show("No matching files found in: " & .FolderPath, "Error")

Return

End If

'-Finally..Process the files

Dim o As HL7PlusFileInfo

For Each o In oFIles

'...Code..

'..When I'm done delete the file

If Not o.DeleteFile() Then

MessageBox.Show(o.LastError, "Error Deleting")

Return

End If

Enumerator Name: FolderPollResultSortOrder

Description: Used to tell the object the sort order to use on file request operations.

Members:

enSystem = -1

enFileModified = 0

enFileName = 1

enFileSize = 2

enFileModifiedDescending = 3

enFileNameDescending = 4

enFileSizeDescending = 5

Property Name	Data Type	Description
ChildFolderCount	Integer	The number of sub-folders contained in FolderPath.
ChildFolders	List(of HL7PlusFolderInfo)	A .Net List (of HL7PlusFolderInfo) of the immediate child sub-folders in FolderPath. PROGRAMMING NOTE: Folders flagged as HIDDEN or SYSTEM are excluded and will not be in the returned list. If you need to include HIDDEN or SYSTEM folders use GetChildFolders()
DescendantFolders	List(of HL7PlusFolderInfo)	A .Net List (of HL7PlusFolderInfo) of ALL child folders and their descendant folders in FolderPath. PROGRAMMING NOTE: Folders flagged as HIDDEN or SYSTEM are excluded and will not be in the returned list. If you need to include HIDDEN or SYSTEM folders use GetAllDescendantFolders().
Exists	Boolean	Indicates whether FolderPath exists or is visible to the object.
FolderPath	String	The Folder being analyzed (can also be set when you create the object, see Implementation above).
HasChildFolders	Boolean	Indicates whether FolderPath contains any sub-folders.
IgnoreHiddenFiles	Boolean	Default value is True. If True then files flagged as HIDDEN will not be returned when you call PollFolderForFiles().
IgnoreReadOnlyFiles	Boolean	Default value is False. If True then files flagged as READ-ONLY will not be returned when you call PollFolderForFiles().
IgnoreSystemFiles	Boolean	Default value is True. If True then files flagged as SYSTEM will not be returned when you call PollFolderForFiles().
IgnoreZeroByteFiles	Boolean	Default value is False. If True then files with 0 bytes will not be returned when you call PollFolderForFiles().
IsHiddenFolder	Boolean	Indicates whether FolderPath is a windows "hidden" folder.
IsReadOnlyFolder	Boolean	Indicates whether FolderPath is flagged as "Read-Only"
IsSystemFolder	Boolean	Indicates whether FolderPath is flagged as a Windows System folder.
MinimumFileAge	Integer	The minimum age of files (in seconds) a file must be to be considered when you call PollFolderForFiles(). The Default value is 0 (any age). PROGRAMMING NOTE: If set to 60, when polling the folder any files LESS than or equal to 1 minute old will be IGNORED. This includes any files which might be dated in the future (files copied or created on other computers with a System Clock mismatch).
ResultSortOrder	FolderPollResultSortOrder	When you call PollFolderForFiles() what sort order would you like your List returned to be in. The default is enFileModified so the result will be in Last Modified date order Ascending.
Tag	String	A general purpose String Tag value for your use.

Method:	CreateTheFolder()
Paramters:	None
Return Value:	Boolean
Description:	Attempts to create the directory FolderPath if it does not exist. If False a HL7PlusException is generated.

Method:	GetAllDescendantFolders(IncludeHiddenFolders = False, IncludeSystemFolders = False)
Paramters:	1: IncludeHiddenFolders (Boolean) Optional Default = False. Should the returned List include HIDDEN folders. 1: IncludeSystemFolders (Boolean) Optional Default = False. Should the returned List include SYSTEM folders.
Return Value:	List (of HL7PlusFolderInfo)
Description:	A .Net List (of HL7PlusFolderInfo) of ALL child folders and their descendant folders in FolderPath.

Method:	GetChildFolders(IncludeHiddenFolders = False, IncludeSystemFolders = False)
Paramters:	1: IncludeHiddenFolders (Boolean) Optional Default = False. Should the returned List include HIDDEN folders. 1: IncludeSystemFolders (Boolean) Optional Default = False. Should the returned List include SYSTEM folders.
Return Value:	List (of HL7PlusFolderInfo)
Description:	A .Net List (of HL7PlusFolderInfo) of all immediate child folders under FolderPath.

Method:	PollFolderForFiles() + 2 Overloads PollFolderForFiles(strFileExtension) PollFolderForFiles(FileExtensions)
Paramters:	1: strFileExtension (String) A single file extension (only the file extension itself, no wildcard characters or periods). 1: FileExtensions (List (of String) ) A list of which file extensions you wish to retrieve from the folder. Each list item should be only the file extension itself, no wildcard characters or periods.
Return Value:	List (of HL7PlusFileInfo)
Description:	A .Net List (of HL7PlusFileInfo) of all files in FolderPath. This method also considers the following properties IgnoreZeroByteFiles, IgnoreSystemFiles, IgnoreHiddenFiles, IgnoreReadOnlyFiles, and ResultSortOrder.

Event:

PollingFolderForFiles (strFolder, CancelOperation)

Paramters:

1: strFolder (String) Will be the FolderPath property.

2: CancelOperation (Boolean) Initial Value = False- Set this to True if you want to cancel the operation

Condition:

•This event is fired frequently when PollFolderForFiles() is called. Set CancelOperation to True to cancel the operation.

This object class uses our standard HL7PlusException Class interface for error handling wherever possible.

See the HL7PlusException Implementation Reference