GetBoolChoice

1.0.0

GetBoolChoice.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Get-BoolChoice -->
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <command:details>
      <command:name>Get-BoolChoice</command:name>
      <command:verb>Get</command:verb>
      <command:noun>BoolChoice</command:noun>
      <maml:description>
        <maml:para>Module to ask boolean question to user</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>This function ask question to the user and wait his choice between 'y' ($true) and 'n' ($false).</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Get-BoolChoice</maml:name>
        <!-- Parameter: Question -->
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="q">
          <maml:name>Question</maml:name>
          <maml:description>
            <maml:para>The question asked user</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: DefaultValue -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="d">
          <maml:name>DefaultValue</maml:name>
          <maml:description>
            <maml:para>The default value used in case the user just press 'Enter' without passing any value</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: Question -->
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="q">
        <maml:name>Question</maml:name>
        <maml:description>
          <maml:para>The question asked user</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="q">
        <maml:name>q</maml:name>
        <maml:description>
          <maml:para>The question asked user</maml:para>
          <maml:para>This is an alias of the Question parameter.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: DefaultValue -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="d">
        <maml:name>DefaultValue</maml:name>
        <maml:description>
          <maml:para>The default value used in case the user just press 'Enter' without passing any value</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named" aliases="d">
        <maml:name>d</maml:name>
        <maml:description>
          <maml:para>The default value used in case the user just press 'Enter' without passing any value</maml:para>
          <maml:para>This is an alias of the DefaultValue parameter.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
        <maml:description>
          <maml:para>The question asked user</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <!-- OutputType: Boolean -->
      <command:returnValue>
        <dev:type>
          <maml:name>System.Boolean</maml:name>
          <maml:uri />
        </dev:type>
      </command:returnValue>
    </command:returnValues>
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE 1 ----------</maml:title>
        <maml:introduction>
          <maml:para>#1 - Question without default value</maml:para>
        </maml:introduction>
        <dev:code>Get-BoolChoice("Do you want to continue ?")</dev:code>
      </command:example>
      <command:example>
        <maml:title>---------- EXAMPLE 2 ----------</maml:title>
        <maml:introduction>
          <maml:para>#2 - Question without default value</maml:para>
        </maml:introduction>
        <dev:code>Get-BoolChoice("Do you want to continue ?") -d "Y"</dev:code>
      </command:example>
      <command:example>
        <maml:title>---------- EXAMPLE 3 ----------</maml:title>
        <maml:introduction>
          <maml:para>#3 - Question text coming from pipeline</maml:para>
        </maml:introduction>
        <dev:code>"Do you want to continue ?" | Get-BoolChoice</dev:code>
      </command:example>
    </command:examples>
    <maml:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Source code</maml:linkText>
        <maml:uri>https://github.com/toenn-vaot/psmodule-get-bool-choice</maml:uri>
      </maml:navigationLink>
    </maml:relatedLinks>
  </command:command>
</helpItems>