Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / IData Interface / Add Method
Set of data samples to write.
Whether to generate error when replacing exisiting data.
Receives individual write errors.
Example


In This Topic
    Add Method (IData)
    In This Topic
    Write a set of data values to a Historian server. Data writes may be optionally flagged with errorOnReplace=true to protect against replacing previously stored values.

    The chief constraint on number of samples supported in a single write is ConnectionProperties.MaxReceivedMessageSize. This determines the maximum size of a single message transmitted to a Historian server. This parameter must be matched on both client and server.

    Syntax
    Sub Add( _
       ByVal dataset As DataSet, _
       ByVal errorOnReplace As System.Boolean, _
       ByRef errors As ItemErrors _
    ) 
    void Add( 
       DataSet dataset,
       System.bool errorOnReplace,
       out ItemErrors errors
    )
    void Add( 
       DataSet^ dataset,
       System.bool errorOnReplace,
       [Out] ItemErrors^ errors
    ) 

    Parameters

    dataset
    Set of data samples to write.
    errorOnReplace
    Whether to generate error when replacing exisiting data.
    errors
    Receives individual write errors.
    Example
    DataSet set = new DataSet();
    ItemErrors errors;
                  
    // populate tag values
    set["Integer0000"] = new DataSamples<int> { Values = new int[] { 11 }, Times = new DateTime[] { DateTime.UtcNow }, ImplicitQuality = DataQuality.Good };
    set["Double00000"] = new DataSamples<double> { Values = new double[] { 3.14 }, Times = new DateTime[] { DateTime.UtcNow }, ImplicitQuality = DataQuality.Good };
    set["String00000"] = new DataSamples<string> { Values = new string[] { "string value" }, Times = new DateTime[] { DateTime.UtcNow }, ImplicitQuality = DataQuality.Good };
                  
    // write values to server
    connection.IData.Add(set, false, out errors);
    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