en-US/ErrorRecord-help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ErrorRecord</command:name> <command:verb>New</command:verb> <command:noun>ErrorRecord</command:noun> <maml:description> <maml:para>{{ Fill in the Synopsis }}</maml:para> </maml:description> </command:details> <maml:description> <maml:para>{{ Fill in the Description }}</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ErrorRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>{{ Fill Message Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>{{ Fill Category Description }}</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">NotSpecified</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OpenError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CloseError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DeviceError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DeadlockDetected</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvalidArgument</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvalidData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvalidOperation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvalidResult</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvalidType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MetadataError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotImplemented</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotInstalled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectNotFound</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OperationStopped</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OperationTimeout</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SyntaxError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ParserError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PermissionDenied</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ResourceBusy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ResourceExists</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ResourceUnavailable</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReadError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WriteError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FromStdErr</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SecurityError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ProtocolError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AuthenticationError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LimitsExceeded</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">QuotaExceeded</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEnabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ErrorCategory</command:parameterValue> <dev:type> <maml:name>ErrorCategory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exception</maml:name> <maml:description> <maml:para>{{ Fill Exception Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ErrorID</maml:name> <maml:description> <maml:para>{{ Fill ErrorID Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetObject</maml:name> <maml:description> <maml:para>{{ Fill TargetObject Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecommendedAction</maml:name> <maml:description> <maml:para>{{ Fill RecommendedAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InnerException</maml:name> <maml:description> <maml:para>{{ Fill InnerException Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Exception</command:parameterValue> <dev:type> <maml:name>Exception</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>{{ Fill Message Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>{{ Fill Category Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ErrorCategory</command:parameterValue> <dev:type> <maml:name>ErrorCategory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exception</maml:name> <maml:description> <maml:para>{{ Fill Exception Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ErrorID</maml:name> <maml:description> <maml:para>{{ Fill ErrorID Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetObject</maml:name> <maml:description> <maml:para>{{ Fill TargetObject Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecommendedAction</maml:name> <maml:description> <maml:para>{{ Fill RecommendedAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InnerException</maml:name> <maml:description> <maml:para>{{ Fill InnerException Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Exception</command:parameterValue> <dev:type> <maml:name>Exception</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ErrorRecordString</command:name> <command:verb>New</command:verb> <command:noun>ErrorRecordString</command:noun> <maml:description> <maml:para>Creates a new ErrorRecord string that you can paste into your function.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-ErrorRecordString function creates a new ErrorRecord string with the specified error message, category, exception, error ID, target object, and recommended action.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ErrorRecordString</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The error message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>The error category. Default value is 'NotSpecified'.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">NotSpecified</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OpenError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CloseError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DeviceError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DeadlockDetected</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvalidArgument</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvalidData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvalidOperation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvalidResult</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvalidType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MetadataError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotImplemented</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotInstalled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectNotFound</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OperationStopped</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OperationTimeout</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SyntaxError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ParserError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PermissionDenied</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ResourceBusy</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ResourceExists</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ResourceUnavailable</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReadError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WriteError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FromStdErr</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SecurityError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ProtocolError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConnectionError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AuthenticationError</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LimitsExceeded</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">QuotaExceeded</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NotEnabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ErrorCategory</command:parameterValue> <dev:type> <maml:name>ErrorCategory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NotSpecified</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exception</maml:name> <maml:description> <maml:para>The exception type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ErrorID</maml:name> <maml:description> <maml:para>The error ID. Default value is 'NotSpecified'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NotSpecified</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetObject</maml:name> <maml:description> <maml:para>The target object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecommendedAction</maml:name> <maml:description> <maml:para>The recommended action string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CopyToClipboard</maml:name> <maml:description> <maml:para>Copies output to clipboard and not to console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The error message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>The error category. Default value is 'NotSpecified'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ErrorCategory</command:parameterValue> <dev:type> <maml:name>ErrorCategory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NotSpecified</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exception</maml:name> <maml:description> <maml:para>The exception type.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ErrorID</maml:name> <maml:description> <maml:para>The error ID. Default value is 'NotSpecified'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>NotSpecified</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetObject</maml:name> <maml:description> <maml:para>The target object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecommendedAction</maml:name> <maml:description> <maml:para>The recommended action string.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CopyToClipboard</maml:name> <maml:description> <maml:para>Copies output to clipboard and not to console.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="proga"> <maml:name>ProgressAction</maml:name> <maml:description> <maml:para>{{ Fill ProgressAction Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue> <dev:type> <maml:name>ActionPreference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>New-ErrorRecordString -Message "An error occurred" -Exception "System.Exception" -ErrorID "12345" -RecommendedAction "Please try again" -Category WriteError Creates a new ErrorRecord string with the specified parameters.</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |