Samples


In this topic

About samples

Developer samples are provided as instructive examples of patterns and functionality associated with using ESRI server based products and components in Microsoft .NET applications. Samples can be supported in Visual Studio 2008 and 2010. If the sample supports both, a solution is included for both Visual Studio versions. For example, the Common_Callback CSharp sample includes two solution files—one for Visual Studio 2008 (Common_Callback_CSharp2008.sln) and one for Visual Studio 2010 (Common_Callback_CSharp2010.sln). 
Samples are organized by application type, then by application programming interface (API) where applicable. Sample names will often be prefixed with their applicable API. The following prefixes can be used:
  • ArcGIS samples—Work with functionality available in the ArcGIS Server APIs. Sometimes this functionality is demonstrated within the context of another API or framework, such as the Web Application Developer Framework (ADF).
  • ArcGIS SOAP samples—Work with functionality in the ArcGIS Server Simple Object Access Protocol (SOAP) API, usually via a Web service endpoint. 
  • ArcIMS samples—Work with functionality available in the ArcIMS API. Sometimes this functionality is demonstrated within the context of another API or framework, such as the Web ADF.
  • Common samples—Work with functionality available in the Web ADF common API and is not specific to a data source type. The Web ADF common API can utilize data source capabilities in a generic way; therefore, data source specific APIs are not required.   
The following (different) types of samples—projects and snippets—are also provided:
  • Project samples—Include a sample project with code and instructions for design time setup and runtime usage. Links to code files at the bottom of the sample description are also available. Project samples can also reference specific sample data included with the developer Help system. ArcGIS Server specific map documents (.mxd), geocode locator files (.loc), and ArcIMS map configuration files (.axl) are provided.
  • Snippet samples—Include a code section to show a code pattern, no project is included. Each application section is organized alphabetically with project samples before snippet samples.
In most cases, C# and VB.NET versions of a sample are provided.

Unzipping sample files

To unzip sample files, use an unzip utility, such as WinZip or use the Windows XP unzip functionality built into the Windows Explorer shell. You can extract samples to any location; however, extract them to their default locations since they can reference a "data" directory relative to the installation location.
Vista users cannot extract samples to the default installation location in program files. For Vista users, make a copy of the samples and data folders you want to use in a location where you have full permissions and can extract the files. Keep the same folder structure in that location to keep the relative path to the data folder the same.