Export-Alias 帮助信息

 

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

译者 : Edengundam( 马涛 )

 

Export-Alias

 

摘要

将当前定义的别命令信息导出到文件 .

 

语法

Export-Alias [-path] <string> [[-name] <string[]>] [-passThru] [-as {<Csv> | <Script>}] [-append] [-description <string>] [-scope <string>] [-force] [-noClobber] [-whatIf] [-confirm] [<CommonParameters>]

 

详细描述

将当前定义在指定名称空间作用域的别命令信息导出到文件 . 如果指定的输出文件不存在 , cmdlet 将创建它 . 此命令可以将别名信息导出为逗号分隔值 (CSV) 格式或脚本 (Script) 格式 . 两种格式都包含了以 # 注释符号开头的标题信息 : 别名文件 , 导出者 , 日期 / 时间和机器名 .

 

CSV 格式中包含了别名的名称 , 相应的 cmdlet, 可能的别名描述和作用域 . 脚本格式包含同样的信息 , 只不过脚本格式利用 Set-Alias 命令 , 并将别名的信息作为 Set-Alias 命令的参数 .

 

参数

 

-path <string>

指定保存别名信息的文件路径名称 . 你可以使用通配符 , 但是匹配的结果必须是唯一 .

 

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

 

-name <string[]>

指定需要导出别名的名称 . 要输入多个别名名称 , 使用逗号将它们分隔 . 如果你不提供别名名称 , cmdlet 导出当前所有的别名 .

 

强制参数 ?	false
参数位置 ?	2
默认值	*
允许从管道绑定输入 ?	true ( 根据属性名 )
允许通配符扩展 ?	true

 

-passThru <SwitchParameter>

输出此命令创建的对象到管道中 . 默认情况下 , 此命令不会将对象输出到管道 .

 

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

 

-as <ExportAliasFormat>

确定别名导出的格式是逗号分隔值 (CSV) 格式还是脚本格式 . 如下列表为此参数的合法值 :

 

·          Csv

·          Script

 

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

 

-append <SwitchParameter>

将输入添加到指定文件末尾 , 而不是将该文件覆盖 .

 

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

 

-description <string>

允许你为导出文件添加描述信息 . 描述信息位于文件头部 , 仅次于文件标题信息 . 描述信息以 # 符号开头 .

 

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

 

-scope <string>

指定别名应该导入的作用域 . 此值可以是命名作用域 : "global", "local" 或 "script", 也可以是一个相对当前作用于的值 ( 此值范围是从 0 到当前活动的作用域数量 . 0 代表当前作用域 , 1 代表父作用域 ).

 

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

 

-force <SwitchParameter>

在不破坏安全性的前提下 , 能够避免影响命令成功执行的限制条件 . 此 cmdlet 将会在命令完成会尝试恢复文件的只读属性 .

 

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

 

-noClobber <SwitchParameter>

确保 cmdlet 不会覆盖一个文件 . 如果没有指定 NoClobber, Export-Alias 在覆盖指定导出文件时 , 不给出任何警告 . 如果 Append 和 NoClobber 同时指定输出将被添加到现存文件的末尾 .

 

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

 

-whatIf

描述执行此命令将会发生的现象 , 不会真正执行此命令 .

 

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

 

-confirm

执行命令前提示你进行确认 .

 

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

 

< 公共参数 >

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

 

输入类型

System.Management.Automation.AliasInfo

 

返回类型

System.Management.Automation.AliasInfo

 

注意

 

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

 

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

 

Export-Alias 不支持将别名导出到为文件系统的路径中 .

 

例 1

 

C:/PS>export-alias -path alias.txt

notepad alias.txt

 

此命令将当前的别名信息导出到当前路径下的 alias.txt 文件中 . 然后使用 Notepad 打开结果文件 .

 

例 2

 

C:/PS>export-alias -path alias.txt -noclobber

 

此命令试图将当前别名信息导入到文件 alias.txt 中 . 由于指定了参数 NoClobber, 如果当前路径中已经存在名为 alias.txt 的文件 , 此命令将无法成功执行 .

 

例 3

 

C:/PS>export-alias -path alias.txt -append -description "Appended Alias Info"

 

此命令导出当前别名信息到名称为 alias.txt 的文件 . 此命令将描述信息添加到文件的标题注释中 , 如果文件 alias.txt 已经存在并且包含其它内容 , 命令将别名信息追加到文件的末尾 .

 

例 4

 

C:/PS>export-alias -path alias.txt -as script

notepad alias.txt

 

此命令将当前的别名信息导出到名为 alias.txt 的文件 . 如果文件存在 , 它将覆盖以前存在内容 . 别名信息将会导出成使用 Set-Alia s cmdlet 创建别名的命令序列 . 第二行中 , 命令使用 Notepad 打开结果文件 .

 

相关链接

Import-Alias

Get-Alias

New-Alias

Set-Alias