en-us/WindowsUtils.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Send-Click --> <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"> <command:details> <command:name>Send-Click</command:name> <command:verb>Send</command:verb> <command:noun>Click</command:noun> <maml:description> <maml:para>Sends a click.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>When called, this cmdlet sends a click on the current desktop.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Send-Click</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-ComputerSession --> <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"> <command:details> <command:name>Get-ComputerSession</command:name> <command:verb>Get</command:verb> <command:noun>ComputerSession</command:noun> <maml:description> <maml:para>Returns the user sessions on the local or remote computer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet returns the sessions on the local or remote computer.</maml:para> <maml:para>By default, only brings sessions that has an user name assigned.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ComputerSession</maml:name> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name.</maml:para> <maml:para>If no computer name is informed, it returns sessions on the current computer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActiveOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveOnly</maml:name> <maml:description> <maml:para>When called, this Cmdlet returns only active sessions.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeSystemSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSystemSession</maml:name> <maml:description> <maml:para>When called, this Cmdlet includes sessions without an user name assigned.</maml:para> <maml:para>Sessions without user name are marked as 'System'.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name.</maml:para> <maml:para>If no computer name is informed, it returns sessions on the current computer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ActiveOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ActiveOnly</maml:name> <maml:description> <maml:para>When called, this Cmdlet returns only active sessions.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: IncludeSystemSession --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>IncludeSystemSession</maml:name> <maml:description> <maml:para>When called, this Cmdlet includes sessions without an user name assigned.</maml:para> <maml:para>Sessions without user name are marked as 'System'.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-FormattedError --> <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"> <command:details> <command:name>Get-FormattedError</command:name> <command:verb>Get</command:verb> <command:noun>FormattedError</command:noun> <maml:description> <maml:para>Returns the error message for a system error code.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet uses FormatMessage to return the message text for a given 'Win32' system error.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-FormattedError</maml:name> <!-- Parameter: ErrorCode --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ErrorCode</maml:name> <maml:description> <maml:para>The error code.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ErrorCode --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>ErrorCode</maml:name> <maml:description> <maml:para>The error code.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The error code.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-FormattedMessage -ErrorCode 5</dev:code> <dev:remarks> <maml:para>Returning the message for a given error code.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>[System.Runtime.InteropServices.Marshal]::GetLastWin32Error() | Get-FormattedError</dev:code> <dev:remarks> <maml:para>Calling GetLastWin32Error and providing it to the Cmdlet to get the message string.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-LastWin32Error --> <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"> <command:details> <command:name>Get-LastWin32Error</command:name> <command:verb>Get</command:verb> <command:noun>LastWin32Error</command:noun> <maml:description> <maml:para>Returns the last 'Win32' system error message.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet gets the last error thrown by the system, and returns the message string.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-LastWin32Error</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-MsiProperties --> <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"> <command:details> <command:name>Get-MsiProperties</command:name> <command:verb>Get</command:verb> <command:noun>MsiProperties</command:noun> <maml:description> <maml:para>Returns the installer properties from a MSI file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet returns the installer properties from the installer database.</maml:para> <maml:para>Besides standard information, like Product Code, it brings vendor-specific information.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-MsiProperties</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The MSI file path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The MSI file path.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The MSI file path.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Get-ObjectHandle --> <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"> <command:details> <command:name>Get-ObjectHandle</command:name> <command:verb>Get</command:verb> <command:noun>ObjectHandle</command:noun> <maml:description> <maml:para>Returns all processes that have a handle to a file or directory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet return all processes that have a handle to a file or directory.</maml:para> <maml:para>This is particularly useful when a process is preventing a file from being read, modified or deleted.</maml:para> <maml:para>Although working in a different way, this Cmdlet was designed to mimic handle.exe, from Sysinternals suite.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: byPath --> <command:syntaxItem> <maml:name>Get-ObjectHandle</maml:name> <!-- Parameter: Path --> <command:parameter required="false" globbing="true" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The file system object path.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CloseHandle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloseHandle</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: byLiteral --> <command:syntaxItem> <maml:name>Get-ObjectHandle</maml:name> <!-- Parameter: LiteralPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: CloseHandle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloseHandle</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="false" globbing="true" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The file system object path.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: LiteralPath --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>LiteralPath</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PSPath"> <maml:name>PSPath</maml:name> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>This is an alias of the LiteralPath parameter.</maml:para> </maml:description> </command:parameter> <!-- Parameter: CloseHandle --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>CloseHandle</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The file system object path.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ObjectHandle -Path "$env:windir\System32\kernel32.dll", "$env:windir\System32\ntdll.dll"</dev:code> <dev:remarks> <maml:para>Returning processes that have open handles to a list of files.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ObjectHandle $env:TEMP\*.tmp</dev:code> <dev:remarks> <maml:para>Listing all .tmp files on the temp folder, and listing the processes with open handles to those files.</maml:para> <maml:para>The Cmdlet lists the processes related to the files queried to make it easier identify processes when querying a list of files.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> <!-- Cmdlet: Invoke-RemoteMessage --> <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"> <command:details> <command:name>Invoke-RemoteMessage</command:name> <command:verb>Invoke</command:verb> <command:noun>RemoteMessage</command:noun> <maml:description> <maml:para>Sends a message to sessions on local or remote computers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Invoke-RemoteMessage cmdlet sends a MessageBox-Style message to sessions on local or remote computers.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: WithWait --> <command:syntaxItem> <maml:name>Invoke-RemoteMessage</maml:name> <!-- Parameter: Title --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Title</maml:name> <maml:description> <maml:para>The message box title.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message text.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout, in seconds, to wait for a response.</maml:para> <maml:para>If the timeout expires, the cmdlet returns 'Timeout'. The message is not closed.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to send the nessage.</maml:para> <maml:para>If not specified, sends the message to the local host.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session(s) to receive the message.</maml:para> <maml:para>If not specified, sends the message to all sessions.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Style --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Style</maml:name> <maml:description> <maml:para>A list of MessageBox style enum objects.</maml:para> <maml:para>To obtaing a list of available options, call 'Get-RemoteMessageOptions', or see definition for the MessageBox function.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MB_OK</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If called, waits for the user response in the specified 'Timeout'.</maml:para> <maml:para>If not, the Cmdlet returns 'AsyncReturn'.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: NoWait --> <command:syntaxItem> <maml:name>Invoke-RemoteMessage</maml:name> <!-- Parameter: Title --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Title</maml:name> <maml:description> <maml:para>The message box title.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message text.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to send the nessage.</maml:para> <maml:para>If not specified, sends the message to the local host.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session(s) to receive the message.</maml:para> <maml:para>If not specified, sends the message to all sessions.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Style --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Style</maml:name> <maml:description> <maml:para>A list of MessageBox style enum objects.</maml:para> <maml:para>To obtaing a list of available options, call 'Get-RemoteMessageOptions', or see definition for the MessageBox function.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MB_OK</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout, in seconds, to wait for a response.</maml:para> <maml:para>If the timeout expires, the cmdlet returns 'Timeout'. The message is not closed.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Title --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>Title</maml:name> <maml:description> <maml:para>The message box title.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Message --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message text.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ComputerName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to send the nessage.</maml:para> <maml:para>If not specified, sends the message to the local host.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session(s) to receive the message.</maml:para> <maml:para>If not specified, sends the message to all sessions.</maml:para> </maml:description> <command:parameterValue required="true">int[]</command:parameterValue> <dev:type> <maml:name>System.Int32[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Style --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Style</maml:name> <maml:description> <maml:para>A list of MessageBox style enum objects.</maml:para> <maml:para>To obtaing a list of available options, call 'Get-RemoteMessageOptions', or see definition for the MessageBox function.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>MB_OK</dev:defaultValue> </command:parameter> <!-- Parameter: Timeout --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Timeout</maml:name> <maml:description> <maml:para>The timeout, in seconds, to wait for a response.</maml:para> <maml:para>If the timeout expires, the cmdlet returns 'Timeout'. The message is not closed.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If called, waits for the user response in the specified 'Timeout'.</maml:para> <maml:para>If not, the Cmdlet returns 'AsyncReturn'.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-RemoteMessageOptions --> <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"> <command:details> <command:name>Get-RemoteMessageOptions</command:name> <command:verb>Get</command:verb> <command:noun>RemoteMessageOptions</command:noun> <maml:description> <maml:para>Retrieves the options to be used with Invoke-RemoteMessage.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet returns a list of options available to be used with the parameter 'Style', from Invoke-RemoteMessage.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-RemoteMessageOptions</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> </command:command> <!-- Cmdlet: Get-ResourceMessageTable --> <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"> <command:details> <command:name>Get-ResourceMessageTable</command:name> <command:verb>Get</command:verb> <command:noun>ResourceMessageTable</command:noun> <maml:description> <maml:para>Returns the message table stored in a file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet lists all messages, and their index from a resource message table.</maml:para> <maml:para>These message tables are stored into files, like DLL or EXE.</maml:para> <maml:para>I.E.: on kernel32.dll are stored the Win32 system error messages.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ResourceMessageTable</maml:name> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file containing the message table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: Path --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>Path</maml:name> <maml:description> <maml:para>The path to the file containing the message table.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The path to the file containing the message table.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> </command:command> <!-- Cmdlet: Disconnect-Session --> <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"> <command:details> <command:name>Disconnect-Session</command:name> <command:verb>Disconnect</command:verb> <command:noun>Session</command:noun> <maml:description> <maml:para>Logs off an interactive session on the local or remote computer.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This Cmdlet disconnects, or logs off, an interactive session on the local or remote computer.</maml:para> <maml:para>You can retrieve the SessionId with Get-ComputerSession, and use this Cmdled to logoff users.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: WithComputerName --> <command:syntaxItem> <maml:name>Disconnect-Session</maml:name> <!-- Parameter: ComputerName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to disconnect a session.</maml:para> <maml:para>If not informed, it disconnects the session from the local computer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session id to disconnect.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If called, the Cmdlet waits the logoff process to finish before returning.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: NoComputerName --> <command:syntaxItem> <maml:name>Disconnect-Session</maml:name> <!-- Parameter: SessionId --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session id to disconnect.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If called, the Cmdlet waits the logoff process to finish before returning.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: ComputerName --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>The computer name to disconnect a session.</maml:para> <maml:para>If not informed, it disconnects the session from the local computer.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SessionId --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SessionId</maml:name> <maml:description> <maml:para>The session id to disconnect.</maml:para> </maml:description> <command:parameterValue required="true">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: Wait --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If called, the Cmdlet waits the logoff process to finish before returning.</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The computer name to disconnect a session.</maml:para> <maml:para>If not informed, it disconnects the session from the local computer.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.UInt32</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>The session id to disconnect.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Disconnect-Session -SessionId 3</dev:code> <dev:remarks> <maml:para>Disconnects a session with a given session id.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>Get-ComputerSession -ComputerName 'MYAWESOMEPC.contoso.com' | Where-Object { $PSItem.UserName -eq 'CONTOSO\user.name' } | Disconnect-Session -ComputerName 'MYAWESOMEPC.contoso.com' -SessionId $PSItem.SessionId </dev:code> <dev:remarks> <maml:para>Gets the session from a specific user on a remote computer, and loggs it off.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> </command:command> </helpItems> |