GetDeclarationPoint: Operation

GetDeclarationPointResult GetDeclarationPoint(OdId tObject, GetDeclarationPointArg tArg)

Parameters

Description

The GetDeclarationPoint operation gets information about the focused the development environment element.

Comments

The operation gets information about function or procedure if a custom method is used, or about property, method, interface, class if a system assembly is used. To execute the operation, in the tObject field specify unit moniker and in the tArg.cursor field specify the cursor layout coordinates in the code.

The operation results in the information about the focused development environment element.

Example

Below is the example of getting information about development environment interface. The request contains unit moniker and indexes of the row and the column, in which the cursor is located. The response contains assembly and interface name.

SOAP JSON C#

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">

<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

</tObject>

</cursor>

</tArg>

</GetDeclarationPoint>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<moduleName xmlns="">Express</moduleName>

<identName xmlns="">IEaxAnalyzerOptions</identName>

</GetDeclarationPointResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetDeclarationPoint" : 
  {
   "tObject" : 
    {
     "id" : "S1!M!231517"
    },
   "tArg" : 
    {
     "cursor" : 
      {
       "col" : "11",
       "row" : "5"
      }
    }
  }
}

JSON response:

{
 "GetDeclarationPointResult" : 
  {
   "moduleName" : "Express",
   "className" : "",
   "identName" : "IEaxAnalyzerOptions"
  }
}

public static GetDeclarationPointResult GetDeclarationPoint(MbId mb, string moduleId)
{
    var somClient = new SomPortTypeClient(); //Proxy object for operation execution
        //Operation execution parameters
        var tGet = new GetDeclarationPoint()
        {
            tArg = new GetDeclarationPointArg()
            {
                cursor = new CodePoint()
                {
                    row = 5,
                    col = 11
                }
            },
            //Create object moniker
            tObject = new OdId() { id = mb.id + "!" + FindObjectById(mb, moduleId).k }
        };
        //Start assembly
        var result = somClient.GetDeclarationPoint(tGet);
    return result;
}

GetDeclarationPoint

Syntax