Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / IArchives Interface / Remove Method
Name of the archive to remove.
Whether to compress the archive after removal.
Name of the data store to remove file from.



In This Topic
    Remove Method
    In This Topic
    Remove an archive from a server for off-line storage. The archive contents become unavailable for query.
    Syntax
    'Declaration
     
    Sub Remove( _
       ByVal archivename As String, _
       ByVal zipArchive As Boolean, _
       Optional ByVal datastoreName As String _
    ) 
    'Usage
     
    Dim instance As IArchives
    Dim archivename As String
    Dim zipArchive As Boolean
    Dim datastoreName As String
     
    instance.Remove(archivename, zipArchive, datastoreName)
    void Remove( 
       string archivename,
       bool zipArchive,
       string datastoreName
    )
    void Remove( 
       String^ archivename,
       bool zipArchive,
       String^ datastoreName
    ) 

    Parameters

    archivename
    Name of the archive to remove.
    zipArchive
    Whether to compress the archive after removal.
    datastoreName
    Name of the data store to remove file from.
    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