ErrorDetails Class
TOC
Collapse the table of content
Expand the table of content

ErrorDetails Class

Provides additional error information for an error record, such as a more detailed replacement error message.


Namespace: System.Management.Automation
Assembly: System.Management.Automation (in System.Management.Automation.dll)

'Usage
Dim instance As ErrorDetails

[SerializableAttribute] 
public ref class ErrorDetails : ISerializable
/** @attribute SerializableAttribute() */ 
public class ErrorDetails implements ISerializable
SerializableAttribute 
public class ErrorDetails implements ISerializable

ErrorDetails represents additional details about an ErrorRecord, starting with a replacement Message. Clients can use ErrorDetails when they want to display a more specific Message than the one contained in a particular Exception, without having to create a new Exception or define a new Exception class. It is permitted to subclass ErrorDetails but there is no established scenario for doing this, nor has it been tested. The information provided by the ErrorDetails object is accessed through the ErrorRecord.ErrorDetails property. Cmdlets can use this detailed information when they need to display a more specific error message than the exception message contained in an exception, without having to create a new exception or define a new exception class. Note that the exception message is a read-only property.

For more information about error records, see Windows PowerShell Error Records.

The ErrorDetails class is used only by the Windows PowerShell runtime. There are no established scenarios for deriving from this class.


System.Object
  System.Management.Automation.ErrorDetails

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

 

Target Platforms


Show:
© 2016 Microsoft