FRAMES | NO FRAMES
ReturnStdGeography Method

Returns IDs and names of features from specified geography levels that match the given location.

Availability: Business Analyst Server 9.3.1.

StdGeographiesReturnedFeature[] ReturnStdGeography ( 
    ReturnStdGeographyParams  Parameters 
);

Parameter Description
Parameters Geographic search parameters. Type ReturnStdGeographyParams.

Returns

Variable of type StdGeographiesReturnedFeature[] containing the list of IDs and names of features of geography levels matching the given location

Remarks

The ReturnStdGeography method searches in the given standard geography levels for features matching to the given location. Only one feature is selected from matching features per every level of geometry. If no matching feature was found for a level of geometry, the value in corresponding position of the output array a pair of null or empty FeatureID and FeatureName strings.

For example, you can identify standard geography units such as ZIP, Track, Block Group which contain the given point on the map. A point can be specified in a number of ways—using its geographic coordinates, using postal address, or using ZIP code.

Examples

The example below requests standard geography features matching the given location.

C# 
// Instantiate the BAServerHelper class to access analysis methods
BAServerHelper baServerHelper = new BAServerHelper();
baServerHelper.ActiveDatasetID = "USA_ESRI"; // Optional parameter
baServerHelper.IsFullErrorMessage = true;    // Default is false
 
ReturnStdGeographyParams parameters = new ReturnStdGeographyParams();
parameters.GeoLevelIDs = new string[] { "US.States", "US.ZIP5" };
 
// You can use one of following cases:
 
//parameters.Address = new string[] {"8103 Sandy Spring Rd.", "Laurel", "MD" };
parameters.Coordinates = new double[] { -122.463186, 37.754046 };
//parameters.ZIP = "20705";
 
StdGeographiesReturnedFeature[] features = baServerHelper.ReturnStdGeography(parameters);

See Also