SalienceCollection.PrepareTextFromFile

<< SalienceCollection.PrepareCollectionFromList | Back to Salience 6 .Net Index | SalienceCollection.GetCollectionDetails >>

Summary

Provides a file containing multiple related pieces of content to Salience 6 for collection-level analysis. This method, or PrepareCollectionFromList must be called for each new group of content that should be analyzed. The text provided in the file must be 7bit ASCII or valid UTF-8.
This method is a a wrapper around the underlying C API method lxaPrepareCollectionFromFile.

Syntax

public int PrepareCollectionFromFile(string sName, string sFile)

Parameters

sName A descriptive name for the collection
sFile Path to a readable text file containing multiple pieces of related content

Returns

If successful, an integer return code is returned. Developers should check the integer return code to determine if warnings were issued. Otherwise, an exception is thrown with information about the failure of text preparation.

Example

TODO: Example needed for Salience 6

<< SalienceCollection.PrepareCollectionFromList | Back to Salience 6 .Net Index | SalienceCollection.GetCollectionDetails >>