GrouveeCollection.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Import-GrouveeCollection -->
  <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>Import-GrouveeCollection</command:name>
      <command:verb>Import</command:verb>
      <command:noun>GrouveeCollection</command:noun>
      <maml:description>
        <maml:para>Imports and parses a grouvee collection .csv file.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Imports and parses a grouvee collection .csv file which can be created via the 'Export your collection to a CSV file' function on grouvee.com</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Import-GrouveeCollection</maml:name>
        <!-- Parameter: Path -->
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="filepath,filename">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>The fully qualified or relative path to the grouvee collection .csv file.</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: Path -->
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="filepath,filename">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>The fully qualified or relative path to the grouvee collection .csv file.</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, ByPropertyName)" position="0" aliases="filepath,filename">
        <maml:name>filepath</maml:name>
        <maml:description>
          <maml:para>The fully qualified or relative path to the grouvee collection .csv file.</maml:para>
          <maml:para>This is an alias of the Path 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:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="filepath,filename">
        <maml:name>filename</maml:name>
        <maml:description>
          <maml:para>The fully qualified or relative path to the grouvee collection .csv file.</maml:para>
          <maml:para>This is an alias of the Path 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 fully qualified or relative path to the grouvee collection .csv file.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <!-- OutputType: GrouveeGame -->
      <command:returnValue>
        <dev:type>
          <maml:name>GrouveeCollectionParser.GrouveeGame</maml:name>
          <maml:uri />
        </dev:type>
      </command:returnValue>
    </command:returnValues>
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE 1 ----------</maml:title>
        <maml:introduction>
          <maml:para>Example 1: Import a grouvee collection csv file.</maml:para>
          <maml:para></maml:para>
        </maml:introduction>
        <dev:code>PS C:\&gt;Import-GrouveeCollection -Path "C:\Windows\temp\grouvee_export.csv"</dev:code>
        <dev:remarks>
          <maml:para>This command will import a grouvee file from the provided path and</maml:para>
          <maml:para>return a list of all games contained within it.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
  </command:command>
</helpItems>