File Info
Defines the parameters to locate and output a list of file names.
| Reference Information |
| Release Status : |
Stable |
| Alias Name : |
Entity.FileInfo |
| Full Reference Name : |
Collaboris.Saf.Actions.Entities.FileInfo |
| Assembly Name : |
Collaboris.Saf |
| Remarks : |
The list of filenames is stored in a property within the entity called 'FileNames'. This can then be passed into subsequent actions using output properties. |
| Properties |
| Name |
Description |
Example Value |
Output |
Required |
| Path |
String. The local file path containing the files.
|
c:\temp
|
false
|
true
|
| FileNames |
List`1. Contains a list of the file names found in the 'Path'.
|
No example supplied.
|
true
|
false
|
| SearchPattern |
String. The search string to match against the names of files in the path.
Note : The parameter cannot end in two periods ("..") or contain two periods ("..") followed by DirectorySeparatorChar or AltDirectorySeparatorChar, nor can it contain any of the characters in GetInvalidFileNameChars.
|
*.doc
|
false
|
true
|
| SearchOption |
SearchOption. Specifies whether to search the current directory, or the current directory and all subdirectories.
Note : Please supply 'AllDirectories' or 'TopDirectoryOnly' as possible values.
|
AllDirectories
|
false
|
true
|