BCAddressGeocoder.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-Addresses --> <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-Addresses</command:name> <command:verb>Get</command:verb> <command:noun>Addresses</command:noun> <maml:description> <maml:para>Geocode an address</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Represents the set of geocoded and standardized sites and intersections whose address best matches a given query address.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-Addresses</maml:name> <!-- Parameter: AddressString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>AddressString</maml:name> <maml:description> <maml:para>Civic or intersection address as a single string.</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: LocationDescriptor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LocationDescriptor</maml:name> <maml:description> <maml:para>Describes the nature of the address location.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>any</dev:defaultValue> </command:parameter> <!-- Parameter: MatchPrecision --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>MatchPrecision</maml:name> <maml:description> <maml:para>Example: street,locality. A comma separated list of individual match precision levels to include in results.</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: MatchPrecisionNot --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>MatchPrecisionNot</maml:name> <maml:description> <maml:para>Example: street,locality. A comma separated list of individual match precision levels to exclude from results.</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: SiteName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird House).</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: UnitDesignator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>UnitDesignator</maml:name> <maml:description> <maml:para>The type of unit within a house or building.</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: UnitNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>UnitNumber</maml:name> <maml:description> <maml:para>The number of the unit, suite, or apartment within a house or building.</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: UnitNumberSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>UnitNumberSuffix</maml:name> <maml:description> <maml:para>A letter that follows the unit number as in Unit 1A or Suite 302B.</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: CivicNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>CivicNumber</maml:name> <maml:description> <maml:para>The official number assigned to a site by an address authority.</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: CivicNumberSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>CivicNumberSuffix</maml:name> <maml:description> <maml:para>A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St).</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: StreetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="18"> <maml:name>StreetName</maml:name> <maml:description> <maml:para>The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street).</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: StreetType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="19"> <maml:name>StreetType</maml:name> <maml:description> <maml:para>The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St).</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: MaxResults --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>The maximum number of search results to return.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: StreetDirection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="20"> <maml:name>StreetDirection</maml:name> <maml:description> <maml:para>The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities.</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: StreetQualifier --> <command:parameter required="false" globbing="false" pipelineInput="false" position="21"> <maml:name>StreetQualifier</maml:name> <maml:description> <maml:para>Example: the Bridge in Johnson St Bridge. The qualifier of a street name.</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: LocalityName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="22"> <maml:name>LocalityName</maml:name> <maml:description> <maml:para>The name of the locality assigned to a given site by an address authority.</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: ProvinceCode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="23"> <maml:name>ProvinceCode</maml:name> <maml:description> <maml:para>The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>BC</dev:defaultValue> </command:parameter> <!-- Parameter: Localities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="24"> <maml:name>Localities</maml:name> <maml:description> <maml:para>A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns addresses in Nanaimo</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: NotLocalities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="25"> <maml:name>NotLocalities</maml:name> <maml:description> <maml:para>A comma-separated list of localities to exclude from the search.</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: Bbox --> <command:parameter required="false" globbing="false" pipelineInput="false" position="26"> <maml:name>Bbox</maml:name> <maml:description> <maml:para>Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area.</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: Centre --> <command:parameter required="false" globbing="false" pipelineInput="false" position="27"> <maml:name>Centre</maml:name> <maml:description> <maml:para>Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search area. This parameter must be specified together with 'maxDistance'.</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: MaxDistance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="28"> <maml:name>MaxDistance</maml:name> <maml:description> <maml:para>The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Extrapolate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="29"> <maml:name>Extrapolate</maml:name> <maml:description> <maml:para>If true, uses supplied parcelPoint to derive an appropriate accessPoint.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Interpolation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Interpolation</maml:name> <maml:description> <maml:para>accessPoint interpolation method.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>adaptive</dev:defaultValue> </command:parameter> <!-- Parameter: ParcelPoint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="30"> <maml:name>ParcelPoint</maml:name> <maml:description> <maml:para>The coordinates of a point (x,y) known to be inside the parcel containing a given address.</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: Echo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Echo</maml:name> <maml:description> <maml:para>If true, include unmatched address details such as site name in results.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: Brief --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Brief</maml:name> <maml:description> <maml:para>If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AutoComplete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AutoComplete</maml:name> <maml:description> <maml:para>If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SetBack --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SetBack</maml:name> <maml:description> <maml:para>The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: OutputSRS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>OutputSRS</maml:name> <maml:description> <maml:para>The EPSG code of the spatial reference system (SRS) to use for output geometries.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>4326</dev:defaultValue> </command:parameter> <!-- Parameter: MinScore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>MinScore</maml:name> <maml:description> <maml:para>The minimum score required for a match to be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AddressString --> <command:parameter required="false" globbing="false" pipelineInput="false" position="0"> <maml:name>AddressString</maml:name> <maml:description> <maml:para>Civic or intersection address as a single string.</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: LocationDescriptor --> <command:parameter required="false" globbing="false" pipelineInput="false" position="1"> <maml:name>LocationDescriptor</maml:name> <maml:description> <maml:para>Describes the nature of the address location.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>any</dev:defaultValue> </command:parameter> <!-- Parameter: MaxResults --> <command:parameter required="false" globbing="false" pipelineInput="false" position="2"> <maml:name>MaxResults</maml:name> <maml:description> <maml:para>The maximum number of search results to return.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: Interpolation --> <command:parameter required="false" globbing="false" pipelineInput="false" position="3"> <maml:name>Interpolation</maml:name> <maml:description> <maml:para>accessPoint interpolation method.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>adaptive</dev:defaultValue> </command:parameter> <!-- Parameter: Echo --> <command:parameter required="false" globbing="false" pipelineInput="false" position="4"> <maml:name>Echo</maml:name> <maml:description> <maml:para>If true, include unmatched address details such as site name in results.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>True</dev:defaultValue> </command:parameter> <!-- Parameter: Brief --> <command:parameter required="false" globbing="false" pipelineInput="false" position="5"> <maml:name>Brief</maml:name> <maml:description> <maml:para>If true, include only basic match and address details in results. Not supported for shp, csv, and gml formats.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: AutoComplete --> <command:parameter required="false" globbing="false" pipelineInput="false" position="6"> <maml:name>AutoComplete</maml:name> <maml:description> <maml:para>If true, addressString is expected to contain a partial address that requires completion. Not supported for shp, csv, gml formats.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SetBack --> <command:parameter required="false" globbing="false" pipelineInput="false" position="7"> <maml:name>SetBack</maml:name> <maml:description> <maml:para>The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: OutputSRS --> <command:parameter required="false" globbing="false" pipelineInput="false" position="8"> <maml:name>OutputSRS</maml:name> <maml:description> <maml:para>The EPSG code of the spatial reference system (SRS) to use for output geometries.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>4326</dev:defaultValue> </command:parameter> <!-- Parameter: MinScore --> <command:parameter required="false" globbing="false" pipelineInput="false" position="9"> <maml:name>MinScore</maml:name> <maml:description> <maml:para>The minimum score required for a match to be returned.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: MatchPrecision --> <command:parameter required="false" globbing="false" pipelineInput="false" position="10"> <maml:name>MatchPrecision</maml:name> <maml:description> <maml:para>Example: street,locality. A comma separated list of individual match precision levels to include in results.</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: MatchPrecisionNot --> <command:parameter required="false" globbing="false" pipelineInput="false" position="11"> <maml:name>MatchPrecisionNot</maml:name> <maml:description> <maml:para>Example: street,locality. A comma separated list of individual match precision levels to exclude from results.</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: SiteName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="12"> <maml:name>SiteName</maml:name> <maml:description> <maml:para>A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird House).</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: UnitDesignator --> <command:parameter required="false" globbing="false" pipelineInput="false" position="13"> <maml:name>UnitDesignator</maml:name> <maml:description> <maml:para>The type of unit within a house or building.</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: UnitNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="14"> <maml:name>UnitNumber</maml:name> <maml:description> <maml:para>The number of the unit, suite, or apartment within a house or building.</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: UnitNumberSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="15"> <maml:name>UnitNumberSuffix</maml:name> <maml:description> <maml:para>A letter that follows the unit number as in Unit 1A or Suite 302B.</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: CivicNumber --> <command:parameter required="false" globbing="false" pipelineInput="false" position="16"> <maml:name>CivicNumber</maml:name> <maml:description> <maml:para>The official number assigned to a site by an address authority.</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: CivicNumberSuffix --> <command:parameter required="false" globbing="false" pipelineInput="false" position="17"> <maml:name>CivicNumberSuffix</maml:name> <maml:description> <maml:para>A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St).</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: StreetName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="18"> <maml:name>StreetName</maml:name> <maml:description> <maml:para>The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street).</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: StreetType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="19"> <maml:name>StreetType</maml:name> <maml:description> <maml:para>The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St).</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: StreetDirection --> <command:parameter required="false" globbing="false" pipelineInput="false" position="20"> <maml:name>StreetDirection</maml:name> <maml:description> <maml:para>The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities.</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: StreetQualifier --> <command:parameter required="false" globbing="false" pipelineInput="false" position="21"> <maml:name>StreetQualifier</maml:name> <maml:description> <maml:para>Example: the Bridge in Johnson St Bridge. The qualifier of a street name.</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: LocalityName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="22"> <maml:name>LocalityName</maml:name> <maml:description> <maml:para>The name of the locality assigned to a given site by an address authority.</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: ProvinceCode --> <command:parameter required="false" globbing="false" pipelineInput="false" position="23"> <maml:name>ProvinceCode</maml:name> <maml:description> <maml:para>The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>BC</dev:defaultValue> </command:parameter> <!-- Parameter: Localities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="24"> <maml:name>Localities</maml:name> <maml:description> <maml:para>A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns addresses in Nanaimo</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: NotLocalities --> <command:parameter required="false" globbing="false" pipelineInput="false" position="25"> <maml:name>NotLocalities</maml:name> <maml:description> <maml:para>A comma-separated list of localities to exclude from the search.</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: Bbox --> <command:parameter required="false" globbing="false" pipelineInput="false" position="26"> <maml:name>Bbox</maml:name> <maml:description> <maml:para>Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area.</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: Centre --> <command:parameter required="false" globbing="false" pipelineInput="false" position="27"> <maml:name>Centre</maml:name> <maml:description> <maml:para>Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search area. This parameter must be specified together with 'maxDistance'.</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: MaxDistance --> <command:parameter required="false" globbing="false" pipelineInput="false" position="28"> <maml:name>MaxDistance</maml:name> <maml:description> <maml:para>The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Extrapolate --> <command:parameter required="false" globbing="false" pipelineInput="false" position="29"> <maml:name>Extrapolate</maml:name> <maml:description> <maml:para>If true, uses supplied parcelPoint to derive an appropriate accessPoint.</maml:para> </maml:description> <command:parameterValue required="true">bool</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ParcelPoint --> <command:parameter required="false" globbing="false" pipelineInput="false" position="30"> <maml:name>ParcelPoint</maml:name> <maml:description> <maml:para>The coordinates of a point (x,y) known to be inside the parcel containing a given address.</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:returnValues> <!-- OutputType: Address --> <command:returnValue> <dev:type> <maml:name>BCAddressGeocoder.Models.Address</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Test-SampleCmdlet --> <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>Test-SampleCmdlet</command:name> <command:verb>Test</command:verb> <command:noun>SampleCmdlet</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Test-SampleCmdlet</maml:name> <!-- Parameter: FavoriteNumber --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>FavoriteNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: FavoritePet --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>FavoritePet</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Dog</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: FavoriteNumber --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>FavoriteNumber</maml:name> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <!-- Parameter: FavoritePet --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1"> <maml:name>FavoritePet</maml:name> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Dog</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: FavoriteStuff --> <command:returnValue> <dev:type> <maml:name>BCAddressGeocoder.FavoriteStuff</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> </helpItems> |