API Reference
Command
ConvertTo-OfficeCsv
Converts objects or a CSV document into CSV text or a file.
Remarks
Converts objects or a CSV document into CSV text or a file.
Examples
Convert objects to CSV text.
PS>$csv = $data | ConvertTo-OfficeCsv
Generates CSV text from the input objects.
Export with a stable schema order.
PS>$rows = @(
[ordered]@{ Id = 1; Name = 'Alpha'; Total = 10.5 },
[ordered]@{ Id = 2; Name = 'Beta'; Total = 7.25 }
)
$rows | ConvertTo-OfficeCsv -OutputPath .\export.csv -Delimiter ';'
Uses ordered dictionaries to enforce column order and a custom delimiter.
Write CSV without headers.
PS>$data | ConvertTo-OfficeCsv -IncludeHeader:$false -OutputPath .\noheader.csv
Writes rows only when a downstream system expects headerless CSV.
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
ConvertTo-OfficeCsv [-Culture <CultureInfo>] [-Delimiter <Char>] [-Encoding <Encoding>] [-IncludeHeader <Boolean>] [-InputObject <Object>] [-NewLine <String>] [-OutputPath <String>] [-PassThru] [<CommonParameters>]#Parameter set:
InputObjectParameters
- Culture CultureInfo
- Culture used for value formatting.
- Delimiter Char
- Field delimiter character.
- Encoding Encoding
- Encoding used when writing files.
- IncludeHeader Boolean
- Include the header row in the output.
- InputObject Object
- Objects to convert into CSV rows.
- NewLine String
- Override the newline sequence.
- OutputPath String
- Optional output path for the CSV file.
- PassThru SwitchParameter
- Emit a FileInfo when saving to disk.
Outputs
System.String System.IO.FileInfo
ConvertTo-OfficeCsv [-Culture <CultureInfo>] [-Delimiter <Char>] -Document <CsvDocument> [-Encoding <Encoding>] [-IncludeHeader <Boolean>] [-NewLine <String>] [-OutputPath <String>] [-PassThru] [<CommonParameters>]#Parameter set:
DocumentParameters
- Culture CultureInfo
- Culture used for value formatting.
- Delimiter Char
- Field delimiter character.
- Document CsvDocument
- CSV document to serialize.
- Encoding Encoding
- Encoding used when writing files.
- IncludeHeader Boolean
- Include the header row in the output.
- NewLine String
- Override the newline sequence.
- OutputPath String
- Optional output path for the CSV file.
- PassThru SwitchParameter
- Emit a FileInfo when saving to disk.
Outputs
System.String System.IO.FileInfo