en-US/RDExSessionInfo.dll-Help.xml

<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
  <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>Get-RDExSessionInfo</command:name>
      <maml:description>
        <maml:para>Returns the extended state information about activbe RDP sessions.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>RDExSesssionInfo</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>Get-RDExSessionInfo is a wrapper for the native Windows WTS API. It queries the WinStation sessions running on the current machine and returns some details not easily obtainable by standard means.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-RDExSessionInfo</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true" position="1">
          <maml:name>UserName</maml:name>
          <command:parameterValue required="false" variableLength="false">string[]</command:parameterValue>
          <maml:description>
            <maml:para>User name(s) to get the session info for.</maml:para>
          </maml:description>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named">
        <maml:name>UserName</maml:name>
        <maml:description>
          <maml:para>User name(s) to get the session info for.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">string[]</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri></maml:uri>
          <maml:description>
            <maml:para>Collection of String values.</maml:para>
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>You cann pipe objects from Get-RDUserSession to Get-RDExSessionInfo.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>RDExInformation</maml:name>
          <maml:uri></maml:uri>
          <maml:description>
            <maml:para />
          </maml:description>
        </dev:type>
        <maml:description>
          <maml:para>This cmdlet returns RDExInformation objects.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors />
    <command:nonTerminatingErrors />
    <maml:alertSet>
      <maml:title>NOTES:</maml:title>
      <maml:alert>
        <maml:para>Coming as we go...</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>
          -------------------------- EXAMPLE 1 --------------------------
        </maml:title>
        <maml:introduction>
          <maml:para>The simplest way to call Get-RDExSesionInfo is without supplying any parameters:</maml:para>
        </maml:introduction>
        <dev:code>
          Get-RDExSessionInfo
        </dev:code>
        <dev:remarks>
          <maml:para>Get-RDExSessionInfo outputs a collection of RDExSessionInformation objects.</maml:para>
        </dev:remarks>
        <command:commandLines>
          <command:commandLine>
            <command:commandText />
          </command:commandLine>
        </command:commandLines>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Author's webpage:</maml:linkText>
        <maml:uri>http://it-pro-berlin.de</maml:uri>
      </maml:navigationLink>
    </maml:relatedLinks>
  </command:command>
</helpItems>