API Reference
Command
Get-OfficeCsvData
Reads CSV rows as PSCustomObjects or dictionaries.
Remarks
Reads CSV rows as PSCustomObjects or dictionaries.
Examples
Read rows as PSCustomObjects.
PS>Get-OfficeCsvData -Path .\data.csv | Format-Table
Returns each row as a PSCustomObject.
Read rows as dictionaries.
PS>Get-OfficeCsvData -Path .\data.csv -AsHashtable | ForEach-Object { $_['Name'] }
Uses hashtables for dynamic schemas or key-based access.
Read semicolon-delimited data without headers.
PS>Get-OfficeCsvData -Path .\data.csv -Delimiter ';' -HasHeaderRow:$false
Reads CSV files that lack a header row and use a custom delimiter.
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
Get-OfficeCsvData [-AllowEmptyLines] [-AsHashtable] [-Culture <CultureInfo>] [-Delimiter <Char>] [-Document <CsvDocument>] [-Encoding <Encoding>] [-HasHeaderRow <Boolean>] [-InputPath <String>] [-Mode <InMemory|Stream>] [-TrimWhitespace <Boolean>] [<CommonParameters>]#Parameter set:
All Parameter SetsParameters
- AllowEmptyLines SwitchParameter
- Allow empty lines in the input.
- AsHashtable SwitchParameter
- Emit dictionaries instead of PSCustomObjects.
- Culture CultureInfo
- Culture used for type conversions.
- Delimiter Char
- Field delimiter character.
- Document CsvDocument
- CSV document to read when already loaded.
- Encoding Encoding
- Encoding used when reading the file.
- HasHeaderRow Boolean
- Indicates whether the first record is a header row.
- InputPath String
- Path to a CSV file.
- Mode CsvLoadMode
- Load mode controlling materialization.
- Possible values:
InMemory,Stream - TrimWhitespace Boolean
- Trim whitespace around unquoted fields.
Outputs
System.Object