Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / IArchives Interface / Add Method
A unique archive name.
Full path of the archive file.
Whether to create (true) or load an exisiting archive file (false).
Initial archive file size.
Name of the data store to add the file to.



In This Topic
    Add Method (IArchives)
    In This Topic
    Add an archive to a Historian server. An archive may be newly created by the server or an existing, previously removed archive file.
    Syntax
    'Declaration
     
    Sub Add( _
       ByVal archivename As String, _
       ByVal path As String, _
       ByVal create As Boolean, _
       ByVal filesizeInMB As UInteger, _
       Optional ByVal datastoreName As String _
    ) 
    'Usage
     
    Dim instance As IArchives
    Dim archivename As String
    Dim path As String
    Dim create As Boolean
    Dim filesizeInMB As UInteger
    Dim datastoreName As String
     
    instance.Add(archivename, path, create, filesizeInMB, datastoreName)
    void Add( 
       string archivename,
       string path,
       bool create,
       uint filesizeInMB,
       string datastoreName
    )
    void Add( 
       String^ archivename,
       String^ path,
       bool create,
       uint filesizeInMB,
       String^ datastoreName
    ) 

    Parameters

    archivename
    A unique archive name.
    path
    Full path of the archive file.
    create
    Whether to create (true) or load an exisiting archive file (false).
    filesizeInMB
    Initial archive file size.
    datastoreName
    Name of the data store to add the file to.
    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