nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to get return value from python tool

Anonymous User

Hi Guys,

I am currently trying to find out how to get return back value from python tool box.

Below is the snippet of Python and C#, not sure why when I run the code whole ArcGIS pro hang.

I have done similar way before but working properly but not sure why it is happening with these.

Python snippet (ouputLayerInfo value is the one want to return to c# side)

<SPAN class="comment token"># -*- coding: utf-8 -*-</SPAN>

<SPAN class="keyword token">import</SPAN> arcpy
<SPAN class="keyword token">import</SPAN> json
<SPAN class="keyword token">import</SPAN> sys

<SPAN class="keyword token">class</SPAN> <SPAN class="token class-name">Toolbox</SPAN><SPAN class="punctuation token">(</SPAN>object<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
    <SPAN class="keyword token">def</SPAN> <SPAN class="token function">__init__</SPAN><SPAN class="punctuation token">(</SPAN>self<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
        <SPAN class="string token">"""Define the toolbox (the name of the toolbox is the name of the
        .pyt file)."""</SPAN>
        self<SPAN class="punctuation token">.</SPAN>label <SPAN class="operator token">=</SPAN> <SPAN class="string token">"Toolbox"</SPAN>
        self<SPAN class="punctuation token">.</SPAN>alias <SPAN class="operator token">=</SPAN> <SPAN class="string token">""</SPAN>

        <SPAN class="comment token"># List of tool classes associated with this toolbox</SPAN>
        self<SPAN class="punctuation token">.</SPAN>tools <SPAN class="operator token">=</SPAN> <SPAN class="punctuation token">[</SPAN>GetLayerDataConnections<SPAN class="punctuation token">]</SPAN>


<SPAN class="keyword token">class</SPAN> <SPAN class="token class-name">GetLayerDataConnections</SPAN><SPAN class="punctuation token">(</SPAN>object<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
    <SPAN class="keyword token">def</SPAN> <SPAN class="token function">__init__</SPAN><SPAN class="punctuation token">(</SPAN>self<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
        <SPAN class="string token">"""Define the tool (tool name is the name of the class)."""</SPAN>
        self<SPAN class="punctuation token">.</SPAN>label <SPAN class="operator token">=</SPAN> <SPAN class="string token">"GetLayerDataConnections"</SPAN>
        self<SPAN class="punctuation token">.</SPAN>description <SPAN class="operator token">=</SPAN> <SPAN class="string token">"Get Layer Data Connections"</SPAN>
        self<SPAN class="punctuation token">.</SPAN>canRunInBackground <SPAN class="operator token">=</SPAN> <SPAN class="token boolean">True</SPAN>

    <SPAN class="keyword token">def</SPAN> <SPAN class="token function">getParameterInfo</SPAN><SPAN class="punctuation token">(</SPAN>self<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
        <SPAN class="string token">"""Define parameter definitions"""</SPAN>
        <SPAN class="comment token"># First parameter</SPAN>
        param0 <SPAN class="operator token">=</SPAN> arcpy<SPAN class="punctuation token">.</SPAN>Parameter<SPAN class="punctuation token">(</SPAN>
            displayName<SPAN class="operator token">=</SPAN><SPAN class="string token">"Layer File Location"</SPAN><SPAN class="punctuation token">,</SPAN>
            name<SPAN class="operator token">=</SPAN><SPAN class="string token">"Layerfile_location"</SPAN><SPAN class="punctuation token">,</SPAN>
             datatype<SPAN class="operator token">=</SPAN><SPAN class="string token">"GPString"</SPAN><SPAN class="punctuation token">,</SPAN>
            parameterType<SPAN class="operator token">=</SPAN><SPAN class="string token">"Required"</SPAN><SPAN class="punctuation token">,</SPAN>
            direction<SPAN class="operator token">=</SPAN><SPAN class="string token">"Input"</SPAN><SPAN class="punctuation token">)</SPAN>

        params <SPAN class="operator token">=</SPAN> <SPAN class="punctuation token">[</SPAN>param0<SPAN class="punctuation token">]</SPAN>
        <SPAN class="keyword token">return</SPAN> params

    <SPAN class="keyword token">def</SPAN> <SPAN class="token function">isLicensed</SPAN><SPAN class="punctuation token">(</SPAN>self<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
        <SPAN class="string token">"""Set whether tool is licensed to execute."""</SPAN>
        <SPAN class="keyword token">return</SPAN> <SPAN class="token boolean">True</SPAN>

    <SPAN class="keyword token">def</SPAN> <SPAN class="token function">updateParameters</SPAN><SPAN class="punctuation token">(</SPAN>self<SPAN class="punctuation token">,</SPAN> parameters<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
        <SPAN class="string token">"""Modify the values and properties of parameters before internal
        validation is performed.  This method is called whenever a parameter
        has been changed."""</SPAN>
        <SPAN class="keyword token">return</SPAN>

    <SPAN class="keyword token">def</SPAN> <SPAN class="token function">updateMessages</SPAN><SPAN class="punctuation token">(</SPAN>self<SPAN class="punctuation token">,</SPAN> parameters<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
        <SPAN class="string token">"""Modify the messages created by internal validation for each tool
        parameter.  This method is called after internal validation."""</SPAN>
        <SPAN class="keyword token">return</SPAN>

    <SPAN class="keyword token">def</SPAN> <SPAN class="token function">execute</SPAN><SPAN class="punctuation token">(</SPAN>self<SPAN class="punctuation token">,</SPAN> parameters<SPAN class="punctuation token">,</SPAN> messages<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
        layerfileLocation <SPAN class="operator token">=</SPAN> parameters<SPAN class="punctuation token">[</SPAN><SPAN class="number token">0</SPAN><SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">.</SPAN>valueAsText
        
        ouputLayerInfo <SPAN class="operator token">=</SPAN> <SPAN class="punctuation token">[</SPAN><SPAN class="punctuation token">]</SPAN>
        aLayerFile <SPAN class="operator token">=</SPAN> arcpy<SPAN class="punctuation token">.</SPAN>mp<SPAN class="punctuation token">.</SPAN>LayerFile<SPAN class="punctuation token">(</SPAN>layerfileLocation<SPAN class="punctuation token">)</SPAN>
        layerList <SPAN class="operator token">=</SPAN> aLayerFile<SPAN class="punctuation token">.</SPAN>listLayers<SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
        
        <SPAN class="keyword token">for</SPAN> lyr <SPAN class="keyword token">in</SPAN> layerList<SPAN class="punctuation token">:</SPAN>
            <SPAN class="keyword token">if</SPAN> lyr<SPAN class="punctuation token">.</SPAN>supports<SPAN class="punctuation token">(</SPAN><SPAN class="string token">"DATASOURCE"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">:</SPAN>
                conProp <SPAN class="operator token">=</SPAN> lyr<SPAN class="punctuation token">.</SPAN>connectionProperties
                name <SPAN class="operator token">=</SPAN> lyr<SPAN class="punctuation token">.</SPAN>name
                tmpStr <SPAN class="operator token">=</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="string token">"{LayerName:'"</SPAN><SPAN class="operator token">+</SPAN>name<SPAN class="operator token">+</SPAN><SPAN class="string token">"',ConnectionProperties:"</SPAN><SPAN class="operator token">+</SPAN> json<SPAN class="punctuation token">.</SPAN>dumps<SPAN class="punctuation token">(</SPAN>conProp<SPAN class="punctuation token">)</SPAN><SPAN class="operator token">+</SPAN><SPAN class="string token">"}"</SPAN><SPAN class="punctuation token">)</SPAN>
                ouputLayerInfo<SPAN class="punctuation token">.</SPAN>append<SPAN class="punctuation token">(</SPAN>tmpStr<SPAN class="punctuation token">)</SPAN>
        <SPAN class="keyword token">return</SPAN>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

c# snippet

 <SPAN class="keyword token">private</SPAN> <SPAN class="keyword token">void</SPAN> <SPAN class="token function">GetLayerDataSourceInfo</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="keyword token">string</SPAN> layerfilePath<SPAN class="punctuation token">,</SPAN> <SPAN class="keyword token">string</SPAN> toolboxPath<SPAN class="punctuation token">)</SPAN>
        <SPAN class="punctuation token">{</SPAN>
            <SPAN class="keyword token">try</SPAN>
            <SPAN class="punctuation token">{</SPAN>
                <SPAN class="keyword token">var</SPAN> ps <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">ProgressorSource</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Start retrieving datasource....."</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>


                <SPAN class="keyword token">var</SPAN> arguments <SPAN class="operator token">=</SPAN> Geoprocessing<SPAN class="punctuation token">.</SPAN><SPAN class="token function">MakeValueArray</SPAN><SPAN class="punctuation token">(</SPAN>layerfilePath<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

                <SPAN class="keyword token">var</SPAN> gpResult <SPAN class="operator token">=</SPAN> Geoprocessing<SPAN class="punctuation token">.</SPAN><SPAN class="token function">ExecuteToolAsync</SPAN><SPAN class="punctuation token">(</SPAN>toolboxPath<SPAN class="punctuation token">,</SPAN> arguments<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

                <SPAN class="keyword token">using</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="keyword token">var</SPAN> progress <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">ProgressDialog</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Retrieving datasources"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>
                <SPAN class="punctuation token">{</SPAN>
                    <SPAN class="keyword token">var</SPAN> status <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">ProgressorSource</SPAN><SPAN class="punctuation token">(</SPAN>progress<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

                    progress<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Show</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
                    gpResult<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Wait</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
                    progress<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Hide</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
                <SPAN class="punctuation token">}</SPAN>


                IGPResult ProcessingResult <SPAN class="operator token">=</SPAN> gpResult<SPAN class="punctuation token">.</SPAN>Result<SPAN class="punctuation token">;</SPAN>
                <SPAN class="keyword token">if</SPAN> <SPAN class="punctuation token">(</SPAN>ProcessingResult<SPAN class="punctuation token">.</SPAN>IsFailed<SPAN class="punctuation token">)</SPAN>
                <SPAN class="punctuation token">{</SPAN>
                    <SPAN class="keyword token">string</SPAN> errorMessage <SPAN class="operator token">=</SPAN> <SPAN class="string token">""</SPAN><SPAN class="punctuation token">;</SPAN>
                    <SPAN class="keyword token">foreach</SPAN> <SPAN class="punctuation token">(</SPAN>IGPMessage gpMessage <SPAN class="keyword token">in</SPAN> ProcessingResult<SPAN class="punctuation token">.</SPAN>Messages<SPAN class="punctuation token">)</SPAN>
                    <SPAN class="punctuation token">{</SPAN>
                        errorMessage <SPAN class="operator token">+</SPAN><SPAN class="operator token">=</SPAN> $<SPAN class="string token">"{{Error Code: {gpMessage.ErrorCode}, Text :  {gpMessage.Text} }}"</SPAN><SPAN class="punctuation token">;</SPAN>
                    <SPAN class="punctuation token">}</SPAN>

                    MessageBox<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Show</SPAN><SPAN class="punctuation token">(</SPAN>$<SPAN class="string token">"Geoprocessing fail {Environment.NewLine}{errorMessage}"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
                <SPAN class="punctuation token">}</SPAN>
                <SPAN class="keyword token">else</SPAN>
                <SPAN class="punctuation token">{</SPAN>
                    <SPAN class="keyword token">string</SPAN> outvalue <SPAN class="operator token">=</SPAN> ProcessingResult<SPAN class="punctuation token">.</SPAN>ReturnValue<SPAN class="punctuation token">;</SPAN>
                    Console<SPAN class="punctuation token">.</SPAN><SPAN class="token function">WriteLine</SPAN><SPAN class="punctuation token">(</SPAN>outvalue<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
                    MessageBox<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Show</SPAN><SPAN class="punctuation token">(</SPAN>$<SPAN class="string token">"Return value {Environment.NewLine}"</SPAN> <SPAN class="operator token">+</SPAN> outvalue<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
                <SPAN class="punctuation token">}</SPAN>

            <SPAN class="punctuation token">}</SPAN>
            <SPAN class="keyword token">catch</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="token class-name">Exception</SPAN> exce<SPAN class="punctuation token">)</SPAN>
            <SPAN class="punctuation token">{</SPAN>
               <SPAN class="comment token">//log</SPAN>
                
            <SPAN class="punctuation token">}</SPAN>
        <SPAN class="punctuation token">}</SPAN>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Uma Harano‌, Wolfgang Kaiser‌

Find more posts tagged with

Accepted answers

Wolf

Hi Than Aung‌,

I can't speak to your tools and I think that Amir is answering your questions to that regard, but as far as calling a geoprocessing tool from .Net I noticed that IGPResult doesn't return all warnings/error strings in all cases and in some cases i get a wrong success status. So I call ExecuteToolAsync using the callback parameter to examine 'OnValidate' message types in the call back. In some cases, like for example in the sample below errors are only coming back via the 'OnValidate' callback.

<SPAN class="keyword token">protected</SPAN> <SPAN class="keyword token">override</SPAN> <SPAN class="keyword token">async</SPAN> <SPAN class="keyword token">void</SPAN> <SPAN class="token function">OnClick</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
<SPAN class="punctuation token">{</SPAN>
  <SPAN class="comment token">// get the testpoint layer</SPAN>
  <SPAN class="keyword token">try</SPAN>
  <SPAN class="punctuation token">{</SPAN>
    <SPAN class="keyword token">var</SPAN> layerName <SPAN class="operator token">=</SPAN> <SPAN class="string token">"TestPoints"</SPAN><SPAN class="punctuation token">;</SPAN>
    <SPAN class="keyword token">var</SPAN> field <SPAN class="operator token">=</SPAN> <SPAN class="string token">"Description"</SPAN><SPAN class="punctuation token">;</SPAN>
    <SPAN class="keyword token">var</SPAN> expression <SPAN class="operator token">=</SPAN> <SPAN class="string token">"'Test'"</SPAN><SPAN class="punctuation token">;</SPAN>
    <SPAN class="keyword token">var</SPAN> featureLayer <SPAN class="operator token">=</SPAN> MapView<SPAN class="punctuation token">.</SPAN>Active<SPAN class="punctuation token">.</SPAN>Map<SPAN class="punctuation token">.</SPAN><SPAN class="token function">GetLayersAsFlattenedList</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN>OfType<SPAN class="operator token"><</SPAN>FeatureLayer<SPAN class="operator token">></SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="token function">Where</SPAN><SPAN class="punctuation token">(</SPAN>fl <SPAN class="operator token">=</SPAN><SPAN class="operator token">></SPAN> fl<SPAN class="punctuation token">.</SPAN>Name<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Contains</SPAN><SPAN class="punctuation token">(</SPAN>layerName<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="token function">FirstOrDefault</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
    <SPAN class="keyword token">var</SPAN> msg <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">await</SPAN> <SPAN class="token function">CalcFieldGeoprocessingAsync</SPAN><SPAN class="punctuation token">(</SPAN>featureLayer<SPAN class="punctuation token">,</SPAN> field<SPAN class="punctuation token">,</SPAN> expression<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
    MessageBox<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Show</SPAN><SPAN class="punctuation token">(</SPAN>$<SPAN class="string token">@"Calc field returned: {msg}"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
  <SPAN class="punctuation token">}</SPAN>
  <SPAN class="keyword token">catch</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="token class-name">Exception</SPAN> ex<SPAN class="punctuation token">)</SPAN>
  <SPAN class="punctuation token">{</SPAN>
    MessageBox<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Show</SPAN><SPAN class="punctuation token">(</SPAN>$<SPAN class="string token">@"{ex}"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
  <SPAN class="punctuation token">}</SPAN>
<SPAN class="punctuation token">}</SPAN>

<SPAN class="comment token">// cancellation token</SPAN>
<SPAN class="keyword token">private</SPAN> System<SPAN class="punctuation token">.</SPAN>Threading<SPAN class="punctuation token">.</SPAN>CancellationTokenSource _cts <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">System<SPAN class="punctuation token">.</SPAN>Threading<SPAN class="punctuation token">.</SPAN>CancellationTokenSource</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

<SPAN class="keyword token">public</SPAN> <SPAN class="keyword token">async</SPAN> Task<SPAN class="operator token"><</SPAN><SPAN class="keyword token">string</SPAN><SPAN class="operator token">></SPAN> <SPAN class="token function">CalcFieldGeoprocessingAsync</SPAN><SPAN class="punctuation token">(</SPAN>FeatureLayer selectionLayer<SPAN class="punctuation token">,</SPAN>
                                                                                                                                                                                          <SPAN class="keyword token">string</SPAN> field<SPAN class="punctuation token">,</SPAN> <SPAN class="keyword token">string</SPAN> expression<SPAN class="punctuation token">)</SPAN>
<SPAN class="punctuation token">{</SPAN>
  <SPAN class="keyword token">return</SPAN> <SPAN class="keyword token">await</SPAN> QueuedTask<SPAN class="punctuation token">.</SPAN>Run<SPAN class="operator token"><</SPAN><SPAN class="keyword token">string</SPAN><SPAN class="operator token">></SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="keyword token">async</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN> <SPAN class="operator token">=</SPAN><SPAN class="operator token">></SPAN>
  <SPAN class="punctuation token">{</SPAN>
    <SPAN class="keyword token">var</SPAN> stringBuilder <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">StringBuilder</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
    <SPAN class="keyword token">using</SPAN> <SPAN class="punctuation token">(</SPAN>FeatureClass featureClass <SPAN class="operator token">=</SPAN> selectionLayer<SPAN class="punctuation token">.</SPAN><SPAN class="token function">GetFeatureClass</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>
    <SPAN class="punctuation token">{</SPAN>
      <SPAN class="keyword token">string</SPAN> in_table <SPAN class="operator token">=</SPAN> featureClass<SPAN class="punctuation token">.</SPAN><SPAN class="token function">GetPath</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="token function">ToString</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
      IReadOnlyList<SPAN class="operator token"><</SPAN><SPAN class="keyword token">string</SPAN><SPAN class="operator token">></SPAN> calculateParameters <SPAN class="operator token">=</SPAN> Geoprocessing<SPAN class="punctuation token">.</SPAN><SPAN class="token function">MakeValueArray</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">object</SPAN><SPAN class="punctuation token">[</SPAN><SPAN class="punctuation token">]</SPAN> <SPAN class="punctuation token">{</SPAN> in_table<SPAN class="punctuation token">,</SPAN> field<SPAN class="punctuation token">,</SPAN> expression <SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

      <SPAN class="keyword token">var</SPAN> stopWatch <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">Stopwatch</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

      stopWatch<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Start</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
      IGPResult result <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">await</SPAN> Geoprocessing<SPAN class="punctuation token">.</SPAN><SPAN class="token function">ExecuteToolAsync</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"management.CalculateField"</SPAN><SPAN class="punctuation token">,</SPAN>
                      calculateParameters<SPAN class="punctuation token">,</SPAN> <SPAN class="keyword token">null</SPAN><SPAN class="punctuation token">,</SPAN> _cts<SPAN class="punctuation token">.</SPAN>Token<SPAN class="punctuation token">,</SPAN>
                    <SPAN class="punctuation token">(</SPAN>eventName<SPAN class="punctuation token">,</SPAN> o<SPAN class="punctuation token">)</SPAN> <SPAN class="operator token">=</SPAN><SPAN class="operator token">></SPAN>
                    <SPAN class="punctuation token">{</SPAN>
                      System<SPAN class="punctuation token">.</SPAN>Diagnostics<SPAN class="punctuation token">.</SPAN>Debug<SPAN class="punctuation token">.</SPAN><SPAN class="token function">WriteLine</SPAN><SPAN class="punctuation token">(</SPAN>$<SPAN class="string token">@"GP event: {eventName}"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
                      <SPAN class="keyword token">switch</SPAN> <SPAN class="punctuation token">(</SPAN>eventName<SPAN class="punctuation token">)</SPAN>
                      <SPAN class="punctuation token">{</SPAN>
                        <SPAN class="keyword token">case</SPAN> <SPAN class="string token">"OnValidate"</SPAN><SPAN class="punctuation token">:</SPAN> <SPAN class="comment token">// stop execute if any warnings</SPAN>
                                                    <SPAN class="keyword token">if</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">(</SPAN>o <SPAN class="keyword token">as</SPAN> IGPMessage<SPAN class="punctuation token">[</SPAN><SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="token function">Any</SPAN><SPAN class="punctuation token">(</SPAN>it <SPAN class="operator token">=</SPAN><SPAN class="operator token">></SPAN> it<SPAN class="punctuation token">.</SPAN>Type <SPAN class="operator token">==</SPAN> GPMessageType<SPAN class="punctuation token">.</SPAN>Warning<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>
                            _cts<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Cancel</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
                          <SPAN class="keyword token">foreach</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="keyword token">var</SPAN> str <SPAN class="keyword token">in</SPAN> <SPAN class="punctuation token">(</SPAN>o <SPAN class="keyword token">as</SPAN> IGPMessage<SPAN class="punctuation token">[</SPAN><SPAN class="punctuation token">]</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN>
                          <SPAN class="punctuation token">{</SPAN>
                            stringBuilder<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Append</SPAN><SPAN class="punctuation token">(</SPAN>$<SPAN class="string token">@"Warning: {str}"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
                          <SPAN class="punctuation token">}</SPAN>
                          <SPAN class="keyword token">break</SPAN><SPAN class="punctuation token">;</SPAN>
                        <SPAN class="keyword token">case</SPAN> <SPAN class="string token">"OnProgressMessage"</SPAN><SPAN class="punctuation token">:</SPAN>
                          <SPAN class="keyword token">string</SPAN> msg <SPAN class="operator token">=</SPAN> $<SPAN class="string token">@"{eventName}: {(string)o}"</SPAN><SPAN class="punctuation token">;</SPAN>
                          <SPAN class="keyword token">break</SPAN><SPAN class="punctuation token">;</SPAN>
                        <SPAN class="keyword token">case</SPAN> <SPAN class="string token">"OnProgressPos"</SPAN><SPAN class="punctuation token">:</SPAN>
                          <SPAN class="keyword token">string</SPAN> msg2 <SPAN class="operator token">=</SPAN> $<SPAN class="string token">@"{eventName}: {(int)o} %"</SPAN><SPAN class="punctuation token">;</SPAN>
                          stringBuilder<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Append</SPAN><SPAN class="punctuation token">(</SPAN>msg2<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
                          <SPAN class="keyword token">break</SPAN><SPAN class="punctuation token">;</SPAN>
                      <SPAN class="punctuation token">}</SPAN>
                    <SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

      stopWatch<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Stop</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
      <SPAN class="comment token">// Report the results</SPAN>
      <SPAN class="keyword token">if</SPAN> <SPAN class="punctuation token">(</SPAN>result<SPAN class="punctuation token">.</SPAN>IsFailed<SPAN class="punctuation token">)</SPAN>
      <SPAN class="punctuation token">{</SPAN>
        stringBuilder<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Append</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"GP Tool failed: "</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
        <SPAN class="keyword token">foreach</SPAN> <SPAN class="punctuation token">(</SPAN>IGPMessage message <SPAN class="keyword token">in</SPAN> result<SPAN class="punctuation token">.</SPAN>Messages<SPAN class="punctuation token">)</SPAN>
        <SPAN class="punctuation token">{</SPAN>
          stringBuilder<SPAN class="punctuation token">.</SPAN><SPAN class="token function">AppendLine</SPAN><SPAN class="punctuation token">(</SPAN>message<SPAN class="punctuation token">.</SPAN><SPAN class="token function">ToString</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
        <SPAN class="punctuation token">}</SPAN>
      <SPAN class="punctuation token">}</SPAN>
      <SPAN class="keyword token">else</SPAN>
      <SPAN class="punctuation token">{</SPAN>
        stringBuilder<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Append</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Updating rows without an edit operation took: "</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
        stringBuilder<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Append</SPAN><SPAN class="punctuation token">(</SPAN>$<SPAN class="string token">@"{Math.Round(stopWatch.ElapsedMilliseconds / 1000.0, 0)} seconds"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
      <SPAN class="punctuation token">}</SPAN>
      <SPAN class="keyword token">return</SPAN> stringBuilder<SPAN class="punctuation token">.</SPAN><SPAN class="token function">ToString</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
    <SPAN class="punctuation token">}</SPAN>
  <SPAN class="punctuation token">}</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
<SPAN class="punctuation token">}</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

All comments

Anonymous User

Latest update of this question,

Actually noticed I don't need to use python tool to retrieve layer datasource information from lyrx or mapx files.

Anonymous User

Thank Mody Buchbinder‌,

I did try it before I post it, Actually I should try it again since Wolfgang Kaiser‌ callback does not make application hang.

After I reuse, with output as pure GPString, I manage to get the return output from returnvalue from IGPResult and got all parameter value back in Parameters array from IGPResult as well.

That's helpful reminder.

ModyBuchbinder

Hi all

I did not tested it but maybe you should use arcpy.SetParameter in your python code to return a value?

Anonymous User

Thank for your replyNobbir Ahmed‌,

No I didn't see any return message or result in python toolbox, (ArcGIS pro app gptask toolbox result window)

For .net call, I still stick with using gpResult.await() method, rather than await expression because, not sure why I can't retrieve IGPResult with await expression.

As mentioned earlier, It didn't process father from gpResult.Wait() statement. in .net side.

gpnobbir

Do you get any return value when you just run the Python toolbox in ArcGIS Pro app? I don't see any - the pyt tool does not return any value from Pro App - thus .Net call also doesn't get any value.

Let me work on this - will get back with a working answer.

Anonymous User

Thank Nobbir Ahmed‌,

Python tool seem to run properly from gptool dialog box. however It is quite annoying that from C# it is just displayed progress bar and never end. And it is totally hang.

I am using ArcGIS Pro 2.5 , and I have other python tool and having same style of calling from C#, only that python tool seem freezing the whole arcgis pro.

How shall I proceed?

gpnobbir

In the execute method of the Python toolbox you are just using return statement (line# 66) which means you are returning void (or nothing).

I think the return statement should be (WARNING: I think my below statement is wrong - will update the correction soon. 9/28/2020)

<SPAN style="color: #0077aa;">return</SPAN><SPAN style="color: #000000;"> <SPAN style="color: #3d3d3d;">ouputLayerInfo</SPAN></SPAN>

<SPAN class="" style="color: #0077aa; border: 0px; font-weight: inherit;"> </SPAN>

In this call to an Async method, use an "await":

<SPAN class="" style="color: #0077aa; border: 0px; font-weight: inherit;">var</SPAN> gpResult <SPAN class="" style="color: #a67f59; background: rgba(255, 255, 255, 0.5); border: 0px; font-weight: inherit;">=</SPAN> await Geoprocessing<SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">.</SPAN><SPAN class="" style="color: #d74444; border: 0px; font-weight: inherit;">ExecuteToolAsync</SPAN><SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">(</SPAN>toolboxPath<SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">,</SPAN> arguments<SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">)</SPAN><SPAN class="" style="color: #999999; border: 0px; font-weight: inherit;">;</SPAN>

Give it a try and let us know how it goes

Join the Conversation

Signed in members can post, follow updates, and more. New here? Register a free account.

Quick Links

Community Help
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.