Convert-Data Cmdlet
Parameters Output Objects Configuration Settings
The Convert-Data cmdlet is used to encode or decode data from one format to another.
Syntax
Convert-Data [parameters]
Remarks
The data to encode or decode is specified by Data. If decoding, the format to use is set in the From parameter and when encoding, the format to use is set in the To argument. If both are specified, the data will be decoded using the format specified in From and encoded to the format specified in To.
Example The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.
# encodingconvert-data -data test -to base64# decodingconvert-data -data dGVzdA== -from base64Parameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| LogFile | The location of a file to which debug information is written. |
| Charset | The character set of the data. |
| Config | Specifies one or more configuration settings. |
| Data | The data to encode or decode. |
| DataB | The data to encode or decode. |
| From | The format to decode Data with. |
| LogFile | The location of a file to which debug information is written. |
| To | The format to encode Data into. |
Output Objects
The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.
| ConvertedData | This object contains the converted data. |
Configuration Settings
The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.
| Base64LineBreak | Tells the cmdlet whether to include line breaks in Base64 encoded content or not. |
| HMACAlgorithm | The hash algorithm to use when generating a Hash-based Message Authentication Code (HMAC). |
| EncodeHash | Whether the hash value is hex encoded. |
| HMACKey | A key to use when generating a Hash-based Message Authentication Code (HMAC). |
| MaxFileSize | When encoding, controls whether encoded data should be split into several files and gives the maximum allowed size for these files. |
| UseModifiedUTF7 | Specifies whether or not a modified form of UTF-7 for IMAP mailbox naming is used. |
| UseExtendedHexBase32 | Specifies whether or not the Extended Hex alphabet is used. |
| UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
| UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |