Write-Error 帮助信息

 

如下说明是翻译 : help write-error 产生的帮助信息 .

译者 : Edengundam( 马涛 )

 

Write-Error

 

大纲

输出一个对象到错误管道 (error pipeline).

 

语法

Write-Error [-message] <string> [-category {<NotSpecified> | <OpenError> | <CloseError> | <DeviceError> | <DeadlockDetected> | <InvalidArgument> | <InvalidData> | <InvalidOperation> | <InvalidResult> | <InvalidType> | <MetadataError> | <NotImplemented> | <NotInstalled> | <ObjectNotFound> | <OperationStopped> | <OperationTimeout> | <SyntaxError> | <ParserError> | <PermissionDenied> | <ResourceBusy> | <ResourceExists> | <ResourceUnavailable> | <ReadError> | <WriteError> | <FromStdErr> | <SecurityError>}] [-errorId <string>] [-targetObject <Object>] [-recommendedAction <string>] [-categoryActivity <string>] [-categoryReason <string>] [-categoryTargetName <string>] [-categoryTargetType <string>] [<CommonParameters>]

 

Write-Error [-message] <string> -exception <Exception> [-category {<NotSpecified> | <OpenError> | <CloseError> | <DeviceError> | <DeadlockDetected> | <InvalidArgument> | <InvalidData> | <InvalidOperation> | <InvalidResult> | <InvalidType> | <MetadataError> | <NotImplemented> | <NotInstalled> | <ObjectNotFound> | <OperationStopped> | <OperationTimeout> | <SyntaxError> | <ParserError> | <PermissionDenied> | <ResourceBusy> | <ResourceExists> | <ResourceUnavailable> | <ReadError> | <WriteError> | <FromStdErr> | <SecurityError>}] [-errorId <string>] [-targetObject <Object>] [-recommendedAction <string>] [-categoryActivity <string>] [-categoryReason <string>] [-categoryTargetName <string>] [-categoryTargetType <string>] [<CommonParameters>]

 

Write-Error -errorRecord <ErrorRecord> [-recommendedAction <string>] [-categoryActivity <string>] [-categoryReason <string>] [-categoryTargetName <string>] [-categoryTargetType <string>] [<CommonParameters>]

 

详细描述

输出一个对象到错误管道 (error pipeline). 使得你可以输出消息以及其他的信息 , 如 : id, 对象数据 , 和遇到此信息后的建议办法 .

 

参数

 

-message <string>

指定该错误的文本信息 .

 

强制参数 ?	true
参数位置 ?	1
默认值
允许从管道绑定输入 ?	true ( 传值 )
允许通配符扩展 ?	false

 

-category <ErrorCategory>

指定错误的类别 .

 

如下列出了此参数可接受的值 :

 

·          NotSpecified

·          OpenError

·          CloseError

·          DeviceError

·          DeadlockDetected

·          InvalidArgument

·          InvalidData

·          InvalidOperation

·          InvalidResult

·          InvalidType

·          MetadataError

·          NotImplemented

·          NotInstalled

·          ObjectNotFound

·          OperationStopped

·          OperationTimeout

·          SyntaxError

·          ParserError

·          PermissionDenied

·          ResourceBusy

·          ResourceExists

·          ResourceUnavailable

·          ReadError

·          WriteError

·          FromStdErr

·          SecurityError

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-errorId <string>

指定一个与该错误关联的 ID. 每个错误应该对应一个独特的字符串 .

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-targetObject <Object>

指定错误所关联的对象 ( 译者注 : 一般是引起该错误的对象 ).

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-recommendedAction <string>

描述该错误的推荐解决办法 .

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-categoryActivity <string>

描述行为 , 该值将会覆盖 ErrorCategoryInfo 的默认值 .

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-categoryReason <string>

描述 ErrorCategoryInfo 的默认值为覆盖的原因 .

 

强制参数 ?	false
参数位置 ?	named
默认值	从 ErrorCategoryInfo 取得
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-categoryTargetName <string>

指定用来覆盖 ErrorCategoryInfo 默认值的目标名称 .

 

强制参数 ?	false
参数位置 ?	named
默认值	从 ErrorCategoryInfo 取得
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-categoryTargetType <string>

指定用来覆盖 ErrorCategoryInfo 默认值的目标类型 .

 

强制参数 ?	false
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-exception <Exception>

指定错误的异常类型 . 此参数可以用在 Message 和 ErrorRecord 的位置 , 此时此参数应该是所有参数中的第一个 .

 

强制参数 ?	true
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

-errorRecord <ErrorRecord>

指定一个用于描述错误细节的错误记录 (error record). 此参数可以用在 Message 和 Exception 的位置 , 此时此参数应该是所有参数中的第一个 .

 

强制参数 ?	true
参数位置 ?	named
默认值
允许从管道绑定输入 ?	false
允许通配符扩展 ?	false

 

< 公共参数 >

此命令支持公共参数 : -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. 更多信息 , 输入 , "get-help about_commonparameters".

 

输入类型

任意

 

返回类型

错误对象

 

注意

 

更多信息 , 输入 "Get-Help Write-Error -detailed". 需要技术信息 , 输入 "Get-Help Write-Error -full".

 

如果需要为该命令提供多个参数 , 请使用逗号进行分隔 . 例如 , "<parameter-name> <value1>, <value2>".

 

例 1

 

C:/PS>get-childitem | foreach-object { if ($_.gettype().tostring() -eq "Microsoft.Win32.RegistryKey")

{write-error "Out-of-band object" -errorID B1 -targetobject $_ } else {$_ } }

 

如果 Get-ChildItem 返回一个 Microsoft.Win32.Registry 类型的对象 , 则输出一个对象到错误管道 , 当在注册表 provider 的名字空间中 , 执行此命令会引起该类型的对象被返回 .

 

相关链接

Write-Debug

Write-Verbose

Write-Output

Write-Host

Write-Progress

Write-Warning

 

 

 

此命令较为晦涩 , 具体使用法方法有待调查 .