Retourwaarden toevoegen aan een Help-onderwerp voor cmdlets

In deze sectie wordt beschreven hoe u een sectie OUTPUTS toevoegt aan een Help-onderwerp voor PowerShell-cmdlet. De sectie OUTPUTS bevat de .NET-klassen van objecten die door de cmdlet worden retourneren of door de pijplijn worden door gegeven.

Er is geen limiet voor het aantal klassen dat u kunt toevoegen aan de sectie UITVOER. De retourtypen van een cmdlet worden ingesloten in een <command:returnValues> knooppunt, met elke klasse ingesloten in een <command:returnValue> -element.

Als een cmdlet geen uitvoer genereert, gebruikt u deze sectie om aan te geven dat er geen uitvoer is. In plaats van de klassenaam schrijft u bijvoorbeeld Geen en geeft u een korte uitleg. Als de cmdlet uitvoer voorwaardelijk genereert, gebruikt u dit knooppunt om de voorwaarden uit te leggen en de voorwaardelijke uitvoer te beschrijven.

Het schema bevat twee <maml:description> elementen in elk <command:returnValue> element. De Get-Help cmdlet geeft echter alleen de inhoud van het <command:returnValue>/<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 waarin de .NET-klasse wordt beschreven.

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

<command:returnValues>
  <command:returnValue>
    <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: returnValue>
</command: returnValues>

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

<command:returnValues>
  <command:returnValue>
    <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> Get-Date returns a DateTime object. <maml:para>
    </maml:description>
  </command: returnValue>
</command: returnValues>