|
WriterCreateCFFStreamAscii(String, Schema, String, String, Encoding) Method
|
Creates a new Combined File Format (.cff) COMTRADE file stream targeted for ASCII.
Namespace: GSF.COMTRADEAssembly: GSF.COMTRADE (in GSF.COMTRADE.dll) Version: 2.4.218-beta
Syntax Public Shared Function CreateCFFStreamAscii (
fileName As String,
schema As Schema,
Optional infLines As String() = Nothing,
Optional hdrLines As String() = Nothing,
Optional encoding As Encoding = Nothing
) As StreamWriter
static member CreateCFFStreamAscii :
fileName : string *
schema : Schema *
?infLines : string[] *
?hdrLines : string[] *
?encoding : Encoding
(* Defaults:
let _infLines = defaultArg infLines null
let _hdrLines = defaultArg hdrLines null
let _encoding = defaultArg encoding null
*)
-> StreamWriter
GSF.COMTRADE.Writer.CreateCFFStreamAscii = function(fileName, schema, infLines, hdrLines, encoding);
View SourceParameters
- fileName String
- Target file name. Must have ".cff" extension.
- schema Schema
- Schema of file stream.
- infLines String (Optional)
- Lines of "INF" section to write to stream, if any.
- hdrLines String (Optional)
- Lines of "HDR" section to write to stream, if any.
- encoding Encoding (Optional)
- Target encoding; null value will default to UTF-8 (no BOM).
Return Value
StreamWriterNew stream writer for Combined File Format (.cff) COMTRADE file, ready to write at data section.
Remarks
For COMTRADE versions greater than 2001, any use of the term ASCII also inherently implies Unicode UTF-8.
When then
encoding parameter is
null, the default, UTF-8 encoding will be used
for text writes. If ASCII encoding needs to be enforced for backwards compatibility reasons, then the
encoding parameter will need to be set to
ASCII.
See Also