WingsRecordFormat class | QSYS API Reference Guide

Estimated reading time: 2 minutes

Contains functionality to construct the WRF, an XML representation of a file.

Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll

Inheritance: Object

Methods

Signature Description
ComputeSha(XElement) Computes SHA hash value.
CreateWrfFile(String, DataSet, Dictionary<String, String>, DateTime, Int32, Boolean) Create a Wrf file out of dataset and save it in the given path.
GetWrfDoc(DataSet, Dictionary<String, String>, DateTime, Int32, Boolean, Boolean) Get the Wings Record Format XML document.
LoadDataSet(DataSet, String, Dictionary`2&, Boolean) Create the dataset tables for file whose description comes from a Wrf file.
UpdateWrfFile(String, XDocument) Sign the Wrf file and saves it to disk.

string ComputeSha(XElement layoutElement)

Computes SHA hash value.

string ComputeSha(XElement layoutElement)

Parameters

Type Parameter name Description
XElement layoutElement Input XML element.

Returns

Type Description
String The hash value as a string.

void CreateWrfFile(string displayFilePath, DataSet dataSet, Dictionary<string, string> formatLevelIds, DateTime displayFileLastWriteTimeUtc, int ccsid, bool checkFormatLevels)

Create a Wrf file out of dataset and save it in the given path.

void CreateWrfFile(string displayFilePath, DataSet dataSet, Dictionary<string, string> formatLevelIds, DateTime displayFileLastWriteTimeUtc, int ccsid, bool checkFormatLevels)

XDocument GetWrfDoc(DataSet dataSet, Dictionary<string, string> formatLevelIds, DateTime displayFileLastWriteTimeUtc, int ccsid, bool checkFormatLevels, bool computeSha)

Get the Wings Record Format XML document.

XDocument GetWrfDoc(DataSet dataSet, Dictionary<string, string> formatLevelIds, DateTime displayFileLastWriteTimeUtc, int ccsid, bool checkFormatLevels, bool computeSha)

void LoadDataSet(DataSet ds, string formatProps, Dictionary`2& responseIndTemplates, bool throwOnError)

Create the dataset tables for file whose description comes from a Wrf file.

void LoadDataSet(DataSet ds, string formatProps, Dictionary`2& responseIndTemplates, bool throwOnError)

void UpdateWrfFile(string displayFilePath, XDocument wrfDoc)

Sign the Wrf file and saves it to disk.

void UpdateWrfFile(string displayFilePath, XDocument wrfDoc)

Parameters

Type Parameter name Description
String displayFilePath Path to the location where the Wrf file will be saved.
XDocument wrfDoc XDocument containing the Wrf.