Returns a list of filtered configuration section names. The filter is based on a key name and value pair, if the configuration section contains a key with the given value then it will appear in the list.

Parameters:

keyName

The name of the key the section must contain.

keyValue:

The value the key must be set to, to be included in the list.

Return Value:

The list of configuration names that contain a key with the specified value.

Interface Signature:

IList<string> GetConfigListByKey(string keyName, string keyValue);


An example of how this function could be used is shown below.

If a list of calibrations by PNA name were desired then one would use the function as such:

using System;

namespace Example
{
   /// <summary>
   /// An simple example of how to utilize the API and get a reference to it
   /// </summary>
   public class ExampleClass
   {
       /// <summary>
       /// Get PNA by Name
       /// </summary>
       public static IList<string> ListOfCalibrationsByPnaName(string pnaName)
       {
           // Get a reference to the API interface
           AteSystems.InCal.IApi api = AteSystems.InCal.API.Initialize(@"C:\Temp\MyConfig.ini", catchExceptions:true);
           // Call the API function
           return api.GetConfigListByKey("PNA", pnaName);
       }
   }
}