Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / IQueryModifiers Interface / CriteriaFromString Method
String containing sampling mode, calculation mode and/or query modifiers
Resulting criteria based on input string



In This Topic
    CriteriaFromString Method (IQueryModifiers)
    In This Topic
    Retrieves the sampling mode, calculation mode and query modifiers from criteriaString
    Syntax
    'Declaration
     
    Function CriteriaFromString( _
       ByVal criteriaString As String, _
       ByRef criteria As DataCriteria _
    ) As Boolean
    'Usage
     
    Dim instance As IQueryModifiers
    Dim criteriaString As String
    Dim criteria As DataCriteria
    Dim value As Boolean
     
    value = instance.CriteriaFromString(criteriaString, criteria)
    bool CriteriaFromString( 
       string criteriaString,
       ref DataCriteria criteria
    )
    bool CriteriaFromString( 
       String^ criteriaString,
       DataCriteria^% criteria
    ) 

    Parameters

    criteriaString
    String containing sampling mode, calculation mode and/or query modifiers
    criteria
    Resulting criteria based on input string

    Return Value

    True if successfully retrieved values from input string
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also