Dinamikus paraméterek hozzáadása egy szolgáltatói súgótémakörhöz

Ez a szakasz a szolgáltató súgótémakörÉNEK DYNAMIC PARAMETERS szakaszának feltöltését ismerteti.

A dinamikus paraméterek olyan parancsmagok vagy függvények paraméterei, amelyek csak megadott feltételek mellett érhetők el.

A szolgáltatói súgótémakörben dokumentált dinamikus paraméterek azok a dinamikus paraméterek, amelyek a szolgáltató által a parancsmag vagy függvény a szolgáltatói meghajtón való használata során hozzáadhatóak a parancsmaghoz vagy függvényhez.

A dinamikus paraméterek a szolgáltató egyéni parancsmag-súgóiban is dokumentálhatóak. Ha szolgáltatói súgót és egyéni parancsmag-súgót is ír egy szolgáltatóhoz, mindkét dokumentumban foglalja bele a dinamikus paraméter dokumentációját.

Ha egy szolgáltató nem implementálja a dinamikus paramétereket, a szolgáltató súgótémaköre egy üres DynamicParameters elemet tartalmaz.

Dinamikus paraméterek hozzáadása

  1. A fájl <AssemblyName>.dll-help.xml elemen belül providerHelp adjon hozzá egy DynamicParameters elemet. Az elemnek az elem után és DynamicParameters az elem előtt kell Tasks RelatedLinks megjelennie.

    Például:

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

    Ha a szolgáltató nem implementálja a dinamikus paramétereket, az DynamicParameters elem üres is lehet.

  2. A DynamicParameters elemen belül minden dinamikus paraméterhez adjon hozzá egy DynamicParameter elemet.

    Például:

    <DynamicParameters/>
        <DynamicParameter>
        </DynamicParameter>
    </DynamicParameters>
    
  3. Mindegyik DynamicParameter elemhez adjon hozzá egy Name és egy CmdletSupported elemet.

    • Név – A paraméter nevét adja meg
    • CmdletSupported – Azokat a parancsmagokat adja meg, amelyekben a paraméter érvényes. Írja be a parancsmagnevek vesszővel elválasztott listáját.

    Az alábbi XML-fájl például azt a dinamikus paramétert tartalmazza, Windows PowerShell fájlrendszer-szolgáltató hozzáadja a , , Encoding Add-Content Get-Content Set-Content parancsmagokat.

    <DynamicParameters/>
        <DynamicParameter>
            <Name> Encoding </Name>
            <CmdletSupported> Add-Content, Get-Content, Set-Content </CmdletSupported>
    </DynamicParameters>
    
    
  4. Mindegyik DynamicParameter elemhez adjon hozzá egy Type elemet. A elem a elem tárolója, amely a dinamikus paraméter értékének Type Name .NET-típusát tartalmazza.

    Az alábbi XML-fájl például azt mutatja, hogy a dinamikus paraméter .NET-típusa a Encoding FileSystemCmdletProviderEncoding enumeration.

    <DynamicParameters/>
        <DynamicParameter>
            <Name> Encoding </Name>
            <CmdletSupported> Add-Content, Get-Content, Set-Content </CmdletSupported>
            <Type>
                <Name> Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding </Name>
            <Type>
    ...
    </DynamicParameters>
    
  5. Adja hozzá Description a elemet, amely a dinamikus paraméter rövid leírását tartalmazza. A leírás írásakor használja a Paraméterinformációk hozzáadása a parancsmag összes paramétere számára előírt irányelveket.

    Az alábbi XML-fájl például tartalmazza a dinamikus Encoding paraméter leírását.

    <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. Adja hozzá PossibleValues a elemet és annak gyermekelemét. Ezek az elemek együttesen a dinamikus paraméter értékeit írják le. Ez az elem enumerált értékekhez lett kialakítva. Ha a dinamikus paraméter nem használ értéket ( például kapcsolóparaméter esetén ez a helyzet) vagy az értékek nem számbavétele nem lehetséges, adjon hozzá egy üres PossibleValues elemet.

    Az alábbi táblázat felsorolja és leírja az PossibleValues elemet és annak gyermekelemét.

    • PossibleValues – Ez az elem egy tároló. A gyermekelemei az alábbiakban olvashatók. Adjon hozzá PossibleValues egy elemet minden szolgáltatói súgótémakörbe. Az elem üres is lehet.
    • PossibleValue – Ez az elem egy tároló. A gyermekelemei az alábbiakban olvashatók. Adjon hozzá PossibleValue egy elemet a dinamikus paraméter minden értékhez.
    • Érték – Az érték nevét adja meg.
    • Leírás – Ez az elem egy Para elemet tartalmaz. A elemben található Para szöveg a elemben elnevezett értéket írja Value le.

    Az alábbi XML-fájl például a PossibleValue dinamikus paraméter egy Encoding elemét mutatja be.

    <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élda

Az alábbi példa a DynamicParameters dinamikus paraméter Encoding elemét mutatja be.

<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>