PSTypeConverter.ConvertTo Method

  • Reference

Definition

Namespace:
System.Management.Automation
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Overloads

ConvertTo(PSObject, Type, IFormatProvider, Boolean)

Converts the sourceValue parameter to the destinationType parameter using formatProvider and ignoreCase.
ConvertTo(Object, Type, IFormatProvider, Boolean)

Converts the sourceValue parameter to the destinationType parameter using formatProvider and ignoreCase.

ConvertTo(PSObject, Type, IFormatProvider, Boolean)

Converts the sourceValue parameter to the destinationType parameter using formatProvider and ignoreCase.

public:
 virtual System::Object ^ ConvertTo(System::Management::Automation::PSObject ^ sourceValue, Type ^ destinationType, IFormatProvider ^ formatProvider, bool ignoreCase);
public virtual object ConvertTo (System.Management.Automation.PSObject sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase);
abstract member ConvertTo : System.Management.Automation.PSObject * Type * IFormatProvider * bool -> obj
override this.ConvertTo : System.Management.Automation.PSObject * Type * IFormatProvider * bool -> obj
Public Overridable Function ConvertTo (sourceValue As PSObject, destinationType As Type, formatProvider As IFormatProvider, ignoreCase As Boolean) As Object

Parameters

sourceValue
PSObject

Value supposedly from one of the types supported by this converter to be converted to the destinationType parameter.

destinationType
Type

Type to convert the sourceValue parameter, supposedly not one of the types supported by the converter.

formatProvider
IFormatProvider

The format provider to use like in IFormattable's ToString.

ignoreCase
Boolean

True if case should be ignored.

Returns

Object

SourceValue converted to the destinationType parameter using formatProvider and ignoreCase.

Exceptions

InvalidCastException

If no conversion was possible.

Applies to

ConvertTo(Object, Type, IFormatProvider, Boolean)

Converts the sourceValue parameter to the destinationType parameter using formatProvider and ignoreCase.

public:
 abstract System::Object ^ ConvertTo(System::Object ^ sourceValue, Type ^ destinationType, IFormatProvider ^ formatProvider, bool ignoreCase);
public abstract object ConvertTo (object sourceValue, Type destinationType, IFormatProvider formatProvider, bool ignoreCase);
abstract member ConvertTo : obj * Type * IFormatProvider * bool -> obj
Public MustOverride Function ConvertTo (sourceValue As Object, destinationType As Type, formatProvider As IFormatProvider, ignoreCase As Boolean) As Object

Parameters

sourceValue
Object

Value supposedly from one of the types supported by this converter to be converted to the destinationType parameter.

destinationType
Type

Type to convert the sourceValue parameter, supposedly not one of the types supported by the converter.

formatProvider
IFormatProvider

The format provider to use like in IFormattable's ToString.

ignoreCase
Boolean

True if case should be ignored.

Returns

Object

SourceValue converted to the destinationType parameter using formatProvider and ignoreCase.

Exceptions

InvalidCastException

If no conversion was possible.

Applies to