Indexer:Index File (Method)
- Updated2023-02-21
- 2 minute(s) read
Owning Class: NI DataFinder
Requires: LabVIEW DataFinder Toolkit
Indexes the specified file. You can use this method only when you are working with a DataFinder that is running on the same computer. The method does not support DataFinder federations.
Parameter
| Name | Type | Description |
|---|---|---|
| File Path | Path | Specifies which file to index. The file must be located in a search area of the DataFinder. |
| Reindex | Boolean | Specifies whether the DataFinder re-indexes the file (TRUE) or whether the DataFinder only indexes the file if the file was changed or added since the last indexing process (FALSE). |
| Wait Time (s) | Long | Specifies the number of seconds that a VI waits until the DataFinder indexes the file. If you assign the value -1 to the WaitTime parameter, a script waits until the DataFinder has indexed the file. If you assign the value 0 to the WaitTime parameter, the script does not wait for the file to be indexed. |
Output Value
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Index Status | Enumeration | Enumeration with read access and the
following selection terms:
|
 | Note If you call the IndexFile method while the DataFinder is executing an indexing process specified by a scheduler, the DataFinder interrupts the indexing of the scheduler and first executes the method. Then the DataFinder continues the indexing process specified by the scheduler. |
|
| Note If you pause the indexing process of the DataFinder, the IndexFile method is paused until you continue the indexing of the DataFinder. |
|
| Note You can use the method Index File in DataFinder Version 2.2 and later versions. |