Grid Solutions Framework Documentation

GSF Namespaces

GSF.Historian.Files

ArchiveFile Class

ArchiveFile Methods

MaximumDataBlocks Method

OnDataReadException Method

OnDataWriteException Method

OnFileFull Method

OnFutureDataReceived Method

OnHistoricDataReceived Method

OnHistoricFileListBuildComplete Method

OnHistoricFileListBuildException Method

OnHistoricFileListBuildStart Method

OnHistoricFileListUpdated Method

OnMetadataUpdated Method

OnOffloadComplete Method

OnOffloadException Method

OnOffloadProgress Method

OnOffloadStart Method

OnOrphanDataReceived Method

OnOutOfSequenceDataReceived Method

OnProcessAlarmNotification Method

OnRolloverComplete Method

OnRolloverException Method

OnRolloverPreparationComplete Method

OnRolloverPreparationException Method

OnRolloverPreparationStart Method

OnRolloverStart Method

Open Method

ReadData Method

ReadMetaData Method

ReadMetaDataSummary Method

ReadStateData Method

ReadStateDataSummary Method

Rollover Method

Save Method

SaveSettings Method

SynchronizeStateFile Method

WaitForReadersRelease Method

WriteData Method

WriteMetaData Method

WriteStateData Method

ArchiveFile.ReadMetaData Method

Reads MetadataRecord for the specified historianID.

Namespace: GSF.Historian.Files
Assembly: GSF.Historian (in GSF.Historian.dll) Version: 2.4.244-beta

Syntax

C++

JavaScript

Copy

public byte[] ReadMetaData(
	int historianID
)

Public Function ReadMetaData ( 
	historianID As Integer
) As Byte()

public:
virtual array<unsigned char>^ ReadMetaData(
	int historianID
) sealed

abstract ReadMetaData : 
        historianID : int -> byte[] 
override ReadMetaData : 
        historianID : int -> byte[]

function ReadMetaData(historianID);

View Source

Parameters

historianID Int32: Historian identifier.

Return Value

Byte[]
A Byte array containing MetadataRecord of MetadataRecord if found; otherwise null.

Implements

IArchive.ReadMetaData(Int32)

Reference

ArchiveFile Class

GSF.Historian.Files Namespace