Invoertypen toevoegen aan een Help-onderwerp voor cmdlets

In deze sectie wordt beschreven hoe u een sectie INPUTS toevoegt aan een Help-onderwerp voor PowerShell-cmdlet. De sectie INPUTS bevat de .NET-klassen van objecten die de cmdlet accepteert als invoer van de pijplijn, op waarde of op eigenschapsnaam.

Er is geen limiet voor het aantal klassen dat u aan een invoersectie kunt toevoegen. De invoertypen worden in een <command:inputTypes> knooppunt ingesloten, met elke klasse ingesloten in een <command:inputType> -element.

Het schema bevat twee <maml:description> elementen in elk <command:inputType> element. De Get-Help cmdlet geeft echter alleen de inhoud van het <command:inputType>/<maml:description> element weer.

Vanaf PowerShell 3.0 geeft de Get-Help cmdlet de inhoud van het <maml:uri> element weer. Met dit element kunt u gebruikers door sturen naar onderwerpen die de .NET-klasse beschrijven.

De volgende XML toont het <maml:inputTypes> knooppunt.

<command:inputTypes>
  <command:inputType>
    <dev:type>
      <maml:name> Class name </maml:name>
      <maml:uri>  URI of a topic that describes the class </maml:uri>
      <maml:description/>
    </dev:type>
    <maml:description>
      <maml:para> Brief description </maml:para>
    </maml:description>
  </command:inputType>
</command:inputTypes>

De volgende XML toont een voorbeeld van het gebruik van het <maml:inputTypes> knooppunt om een invoertype te documenteren.

<command:inputTypes>
  <command:inputType>
    <dev:type>
      <maml:name>System.DateTime</maml:name>
      <maml:uri>https://docs.microsoft.com/dotnet/api/system.datetime</maml:uri>
      <maml:description/>
    </dev:type>
    <maml:description>
      <maml:para> You can pipe a date to the Set-Date cmdlet. <maml:para>
    <maml:description>
  </command:inputType>
</command:inputTypes>