Jak přidat dynamické parametry do tématu nápovědy zprostředkovatele

V této části se dozvíte, jak naplnit část dynamické parametry tématu nápovědy poskytovatele.

Dynamické parametry jsou parametry rutiny nebo funkce, které jsou k dispozici pouze v zadaných podmínkách.

Dynamické parametry popsané v tématu nápovědy zprostředkovatele jsou dynamické parametry, které poskytovatel přidá do rutiny nebo funkce při použití rutiny nebo funkce na jednotce poskytovatele.

Dynamické parametry lze také zdokumentovat v nápovědě pro vlastní rutiny pro poskytovatele. Při psaní pomocníka pro nápovědu a vlastní rutiny pro poskytovatele zahrňte do obou dokumentů dokumentaci dynamického parametru.

Pokud zprostředkovatel neimplementuje žádné dynamické parametry, téma nápovědy k poskytovateli obsahuje prázdný DynamicParameters prvek.

Přidání dynamických parametrů

  1. V <AssemblyName>.dll-help.xml souboru v rámci providerHelp elementu přidejte DynamicParameters element. DynamicParametersElement by měl být zobrazen za Tasks prvkem a před RelatedLinks elementem.

    Například:

    <providerHelp>
        <Tasks>
        </Tasks>
        <DynamicParameters>
        </DynamicParameters>
        <RelatedLinks>
        </RelatedLinks>
    </providerHelp>
    

    Pokud zprostředkovatel neimplementuje žádné dynamické parametry, DynamicParameters element může být prázdný.

  2. V rámci DynamicParameters elementu pro každý dynamický parametr přidejte DynamicParameter element.

    Například:

    <DynamicParameters/>
        <DynamicParameter>
        </DynamicParameter>
    </DynamicParameters>
    
  3. V každém DynamicParameter elementu přidejte Name CmdletSupported element and.

    • Název – určuje název parametru.
    • CmdletSupported – určuje rutiny, ve kterých je parametr platný. Zadejte čárkami oddělený seznam názvů rutin.

    například následující XML dokumentuje Encoding dynamický parametr, který Windows PowerShell poskytovatel systému souborů přidává do Add-Content Get-Content rutin,, Set-Content rutin.

    <DynamicParameters/>
        <DynamicParameter>
            <Name> Encoding </Name>
            <CmdletSupported> Add-Content, Get-Content, Set-Content </CmdletSupported>
    </DynamicParameters>
    
    
  4. V každém DynamicParameter elementu přidejte Type element. TypeElement je kontejner pro Name prvek, který obsahuje typ .NET hodnoty dynamického parametru.

    Například následující kód XML ukazuje, že typ .NET Encoding dynamického parametru je výčet FileSystemCmdletProviderEncoding .

    <DynamicParameters/>
        <DynamicParameter>
            <Name> Encoding </Name>
            <CmdletSupported> Add-Content, Get-Content, Set-Content </CmdletSupported>
            <Type>
                <Name> Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding </Name>
            <Type>
    ...
    </DynamicParameters>
    
  5. Přidejte Description element, který obsahuje stručný popis dynamického parametru. Při vytváření popisu použijte pokyny předepsané pro všechny parametry rutiny v tématu jak přidat informace o parametrech.

    Například následující kód XML obsahuje popis Encoding dynamického parametru.

    <DynamicParameters/>
        <DynamicParameter>
            <Name> Encoding </Name>
            <CmdletSupported> Add-Content, Get-Content, Set-Content </CmdletSupported>
            <Type>
                <Name> Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding </Name>
            <Type>
            <Description> Specifies the encoding of the output file that contains the content. </Description>
    ...
    </DynamicParameters>
    
  6. Přidejte PossibleValues element a jeho podřízené prvky. Tyto prvky společně popisují hodnoty dynamického parametru. Tento prvek je určený pro výčtové hodnoty. Pokud dynamický parametr nepřijímá hodnotu, jako je například případ s parametrem přepínače, nebo hodnoty nelze vyčíslit, přidejte prázdný PossibleValues element.

    Následující tabulka uvádí a popisuje PossibleValues prvek a jeho podřízené prvky.

    • PossibleValues – tento prvek je kontejnerem. Jeho podřízené prvky jsou popsány níže. Přidejte jeden PossibleValues element do každého tématu nápovědy pro poskytovatele. Element může být prázdný.
    • PossibleValue – tento prvek je kontejnerem. Jeho podřízené prvky jsou popsány níže. Přidejte jeden PossibleValue element pro každou hodnotu dynamického parametru.
    • Value – Určuje název hodnoty.
    • Popis – Tento prvek obsahuje Para element. Text v Para elementu popisuje hodnotu, která je pojmenována v Value elementu.

    Například následující kód XML ukazuje jeden PossibleValue prvek Encoding dynamického parametru.

    <DynamicParameters/>
        <DynamicParameter>
    ...
            <Description> Specifies the encoding of the output file that contains the content. </Description>
            <PossibleValues>
                <PossibleValue>
                    <Value> ASCII </Value>
                    <Description>
                        <para> Uses the encoding for the ASCII (7-bit) character set. </para>
                    </Description>
                </PossibleValue>
    ...
            </PossibleValues>
    </DynamicParameters>
    

Příklad

Následující příklad ukazuje DynamicParameters prvek Encoding dynamického parametru.

<DynamicParameters/>
    <DynamicParameter>
        <Name> Encoding </Name>
        <CmdletSupported> Add-Content, Get-Content, Set-Content </CmdletSupported>
        <Type>
            <Name> Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding </Name>
        <Type>
        <Description> Specifies the encoding of the output file that contains the content. </Description>
        <PossibleValues>
            <PossibleValue>
                <Value> ASCII </Value>
                <Description>
                    <para> Uses the encoding for the ASCII (7-bit) character set. </para>
                </Description>
            </PossibleValue>
            <PossibleValue>
                <Value> Unicode </Value>
                <Description>
                    <para> Encodes in UTF-16 format using the little-endian byte order. </para>
                </Description>
            </PossibleValue>
        </PossibleValues>
</DynamicParameters>