Lägga till dynamiska parametrar i ett hjälpavsnitt för providers

Artikel
09/26/2021

I det här avsnittet beskrivs hur du fyller i avsnittet DYNAMISKA PARAMETRAR i ett hjälpavsnitt för providern.

Dynamiska parametrar är parametrar för en cmdlet eller funktion som endast är tillgängliga under angivna villkor.

De dynamiska parametrar som dokumenteras i ett hjälpavsnitt för providern är de dynamiska parametrar som providern lägger till i cmdleten eller funktionen när cmdleten eller funktionen används på providerenheten.

Dynamiska parametrar kan också dokumenteras i anpassad cmdlet-hjälp för en provider. När du skriver både providerhjälp och anpassad cmdlet-hjälp för en provider ska du inkludera dokumentationen om dynamiska parametrar i båda dokumenten.

Om en leverantör inte implementerar några dynamiska parametrar innehåller providerns hjälpavsnitt ett tomt DynamicParameters element.

Lägga till dynamiska parametrar

Lägg till <AssemblyName>.dll-help.xml ett providerHelp -element i -elementet i DynamicParameters -filen. Elementet DynamicParameters bör visas efter elementet och före elementet Tasks RelatedLinks .

Exempel:
```
<providerHelp>
    <Tasks>
    </Tasks>
    <DynamicParameters>
    </DynamicParameters>
    <RelatedLinks>
    </RelatedLinks>
</providerHelp>
```
Om providern inte implementerar några dynamiska parametrar kan DynamicParameters elementet vara tomt.
Lägg till DynamicParameters ett element för varje dynamisk parameter i elementet DynamicParameter .

Exempel:
```
<DynamicParameters/>
    <DynamicParameter>
    </DynamicParameter>
</DynamicParameters>
```
Lägg till DynamicParameter ett - och Name -element i varje CmdletSupported element.
- Namn – Anger parameternamnet
- CmdletSupported – Anger de cmdlets där parametern är giltig. Skriv en kommaavgränsad lista med cmdlet-namn.
Följande XML dokumenterar till exempel den dynamiska parameter som Encoding Windows PowerShell FileSystem-providern lägger till Add-Content i Get-Content Set-Content cmdletarna , .
```
<DynamicParameters/>
    <DynamicParameter>
        <Name> Encoding </Name>
        <CmdletSupported> Add-Content, Get-Content, Set-Content </CmdletSupported>
</DynamicParameters>
```
Lägg till DynamicParameter ett element i varje Type element. Elementet Type är en container för elementet som innehåller Name .NET-typen för värdet för den dynamiska parametern.

Följande XML visar till exempel att .NET-typen för den dynamiska parametern är Encoding uppräkningen FileSystemCmdletProviderEncoding.
```
<DynamicParameters/>
    <DynamicParameter>
        <Name> Encoding </Name>
        <CmdletSupported> Add-Content, Get-Content, Set-Content </CmdletSupported>
        <Type>
            <Name> Microsoft.PowerShell.Commands.FileSystemCmdletProviderEncoding </Name>
        <Type>
...
</DynamicParameters>
```

Lägg till Description -elementet, som innehåller en kort beskrivning av den dynamiska parametern. När du skriver beskrivningen använder du riktlinjerna som anges för alla cmdlet-parametrar i Så här lägger du till parameterinformation.

Följande XML innehåller till exempel en beskrivning av den Encoding dynamiska parametern.

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

Lägg till PossibleValues elementet och dess underordnade element. Tillsammans beskriver dessa element värdena för den dynamiska parametern. Det här elementet är utformat för uppräknade värden. Om den dynamiska parametern inte tar ett värde, till exempel är fallet med en växelparameter, eller om värdena inte kan räknas upp, lägger du till ett tomt PossibleValues element.

I följande tabell visas och beskrivs PossibleValues elementet och dess underordnade element.
- PossibleValues – det här elementet är en container. De underordnade elementen beskrivs nedan. Lägg till ett PossibleValues element i varje providerhjälpavsnitt. Elementet kan vara tomt.
- PossibleValue – det här elementet är en container. De underordnade elementen beskrivs nedan. Lägg till PossibleValue ett element för varje värde för den dynamiska parametern.
- Värde – Anger värdenamnet.
- Beskrivning – Det här elementet innehåller ett Para -element. Texten i elementet Para beskriver värdet som namnges i elementet Value .
Följande XML visar till exempel ett PossibleValue element i den dynamiska Encoding parametern.
```
<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>
```

Exempel

I följande exempel visas DynamicParameters elementet för den dynamiska Encoding parametern.

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

Lägga till dynamiska parametrar i ett hjälpavsnitt för providers

Lägga till dynamiska parametrar

Exempel

Feedback

Ytterligare resurser