> For the complete documentation index, see [llms.txt](https://docs.geodin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.geodin.com/geodin-desktop/pt/integracoes-e-plug-ins/overview-1/method-reference.md). # Referência do Método Esta página é a referência canónica para a API COM do GeoDin. Descreve os Métodos que uma aplicação externa pode chamar para controlar o GeoDin (como servidor COM) ou para incorporar funções externas no GeoDin como plug-ins. A referência destina-se a programadores de software que combinam o GeoDin com outros produtos ou integram Funções especiais no GeoDin. Para cada Método é indicada a edição do GeoDin requerida. ## Resumo ### Funções COM e Plugins O GeoDin oferece a opção de ligar o GeoDin a aplicações externas. Este capítulo descreve os Métodos técnicos e destina-se a programadores de software, que estão prestes a combinar o GeoDin com outros produtos ou a integrar Funções especiais no GeoDin. Para executar o GeoDin por uma aplicação externa, várias funções estão disponíveis. Uma parte dessas funções é usada para controlar a interface do programa GeoDin (neste caso o GeoDin está Visível para o utilizador), para que uma aplicação externa, como por exemplo um SIG, escolha autonomamente um objeto no gestor de objetos do GeoDin e inicie um Método GeoDin. Outra parte das funções é usada para fornecer Informação do Banco de dados do GeoDin até Imagens gráficas dos objetos. Aqui o GeoDin está geralmente Invisível e gere as suas tarefas no plano de fundo. As funções individuais são descritas na Seção [Funções COM](#com-functions). Para cada função, define-se qual edição do GeoDin é requerida. No outro lado, é possível integrar aplicações externas ou funções na interface do programa GeoDin. Tais funções (os chamados plug-ins) podem, por exemplo, realizar Cálculos especiais ou exportações de dados e são exibidas no GeoDin com um Símbolo do método. Uma descrição para incorporar e configurar estas funções externas é dada na Seção [Plug-ins](#plug-ins) e em [Instalação de plug-ins](/geodin-desktop/pt/integracoes-e-plug-ins/installing-plug-ins.md). ### Funções COM **Dicas para o Usa do GeoDin como servidor COM** A utilização do GeoDin como servidor COM (através da criação de um objeto do Típo `GeoDin.GeODinApplication`) pode ser controlada pelos seguintes Parâmetro. #### Diretório de trabalho da aplicação GeoDin Por Padrão, a Pasta "TEMP" incluido na Pasta "Configurações gerais locais" do Utilizador atual é usada como diretório de trabalho da aplicação GeoDin no modo de arranque como servidor COM. Ao introduzir `ExecutePath=` incluido na Seção `[Sistema]` do [Ficheiro de Configuração GeoDin.ini](/geodin-desktop/pt/instalacao-e-licenciamento/configuration-file-reference.md) outra Pasta pode ser definida. #### Disponibilidade de plug-ins Como Padrão [Plug-ins](#plug-ins) não são carregados quando o GeoDin é Iniciado. Ao introduzir `COMServerPlugins=verdadeiro` incluido na Seção `[Sistema]` do [Ficheiro de Configuração GeoDin.ini](/geodin-desktop/pt/instalacao-e-licenciamento/configuration-file-reference.md) o carregamento do plug-in pode ser alcançado. #### Diretório da aplicação do GeoDin O diretório da aplicação do GeoDin é, por Padrão, a Pasta situada um Nível acima da Pasta BIN (na qual o GeoDin.exe está incluido). Uma Instalação típica do GeoDin tem a seguinte estrutura: ``` C:\Programs\GeoDin (contém GeoDin.ini) C:\Programs\GeoDin\BIN (contém GeoDin.exe) C:\Programs\GeoDin\SYSLIB C:\Programs\GeoDin\Fonte etc. ``` O diretório da aplicação é neste caso `C:\Programs\GeoDin`, onde também é lido o ficheiro de Configuração GeoDin.ini. Com este Nome também são criados os nomes de várias subpastas (por ex., para Fonte, QUERYDEF, LAYOUTS etc.). É possível Configurar o diretório da aplicação do GeoDin para uma Pasta Arbitrário, assim pode-se diferenciar Se o GeoDin é Iniciado diretamente como aplicação pelo Utilizador OU é instanciado como um servidor COM. Para iniciar o GeoDin de forma ("normal") pelo Utilizador, o diretório da aplicação pode ser definido por um parâmetro de linha de comando. Tem de Iniciar com a palavra-chave `-af` e tem de conter subsequentemente um nome de Pasta cheia. ``` C:\Programs\GeoDin\BIN\GeoDin.exe -afC:\Programs\GeoDin\Soluções\Water ``` **Aviso:** Se o nome da Pasta contém espaços Vazio, o Parâmetro inteiro tem de ser colocado entre aspas, por exemplo: ``` C:\Programs\GeoDin\BIN\GeoDin.exe "-afC:\Programs\GeoDin Soluções\Water" ``` Ao Iniciar o GeoDin como servidor COM, um Parâmetro de linha de comandos não é possível. Por isso, foi preparado um Método para o introduzir através do registo. Aqui, o Nome da Pasta da aplicação escolhida tem de ser colocado ANTES do Iniciar do servidor COM no `REG_SZ` chave "ApplicationPasta" na seguinte chave de registo: ``` [HKEY_atual_Utilizador\Software\Sistema GeoDin \COMServer] ``` Com ambos os Métodos, o GeoDin verifica a existência da Pasta e ignora a definição, Se não a encontrar. Mais verificações não ocorrem. Certifique-se de que a Pasta selecionado contém um Ficheiro de Configuração GeoDin.ini e todos os subpastas requerido por GeoDin. ### Plug-ins **Plug-ins** ... são módulos externos (programas / COM server), que são chamados a partir da interface do Utilizador do GeoDin. Assim, um programador de software pode integrar o Iniciar de uma certa aplicação, por exemplo uma função de Exportar especial ou uma Novo função de cálculo, incluido a interface do programa do Utilizador do GeoDin. Para o Utilizador, a aplicação aparece como um «» Método «ordinário» do GeoDin. todos Informação requerido para o Objeto(s) escolhido(s) é transferida ao/à plug-in incluido no gestor de objeto do GeoDin. Assim, adicionalmente funções de análise para uma quantidade selecionado de Objetos podem ser oferecidas pelo plug-in. Um plug-in também pode ser uma aplicação que não funcione com o Banco de dados do GeoDin. A Configuração do plug-in também pode integrar o «calculator» do Sistema operativo na interface do programa do Utilizador do GeoDin. Um plug-in pode ser chamado como aplicação (Ficheiro EXE) ou como função COM de um servidor COM registado. Aqui o Parâmetro Executar **OU** Servidor incluido na Configuração do plug-in. Um servidor COM, que deve ser chamado como um plug-in, tem de cumprir certos Requerimentos, que são descritos abaixo. Para configuração Paso a paso, veja [Instalação de plug-ins](/geodin-desktop/pt/integracoes-e-plug-ins/installing-plug-ins.md). **Definição de um plug-in** A definição E Configuração dos plug-ins a Usa é feita no Ficheiro de Configuração GEODIN.INI, incluido. Com o GeoDin 9, os plugins são definidos No separador Sistema, incluido na Configuração do sistema sob a Seção "Publicações". **1. Lista de plug-ins disponíveis** incluido na Seção `[Plugins]` cada complemento incluido é definido com uma linha e recebe um nome, exemplo: ``` [Plugins] Plugin1=Calcular Plugin2=Exportar ``` ***Aviso:*** *Possivelmente a Seção `[Plugins]` tem de ser criado, se não tiverem sido configurados plug-ins anteriores. Adicionar uma linha contendo `[Plugins]` com um Editor do texto. Para o Fim do Ficheiro GEODIN.INI e Pelo menos uma Linha como `Plugin1=Nome do plug-in`. Usa números consecutivos (`Plugin1=`, `Plugin2=` etc.) para a definição de mais de um plugin.* **2. Definição de um único plug-incluido da lista** Para cada plug-in inserido na Lista `[Plugins]` uma Seção separada no ficheiro de Configuração GEODIN.INI tem de ser criado contendo o Nome do plug-in definido no Paso 1, exemplo: ``` [Calcular] Nome=Calcular Executar=C:\PROGRAMS\GEODIN\BIN\GPI.EXE ``` ***OU*** ``` Server=GeODinPlugin.GeODinPluginSample Módulos=Módulos1 Ícone=C:\PROGRAMS\GEODIN\BIN\CALC.ICO Popup=Falso Espera=Falso DBNode1=1 DBNode2=2,1 ``` Adicione, com o Editor do texto., as linhas específicas ao Ficheiro GEODIN.INI. Os Parâmetro incluido nesta Seção controlam, quais Objetos (incluido no gestor de objeto do GeoDin) em que o plug-in deve ser aplicado sobre (em), qual Ficheiro de programa OU qual função do servidor COM deve ser executada E Se o Utilizador tem de esperar ao/à pela Execução da função. Os seguintes Parâmetro estão definidos: | Parâmetro | Denominação | | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Nome` | Nome do plug-in no gestor do objeto GeoDin (estes nomes são exibidos abaixo do Símbolo do método ou no menu pop-up). | | `Executar` | Programa executável (Nome do ficheiro cheia com caminho). **Exemplo:** `C:\WINDOWS\SYSTEM32\CALC.EXE` | | ***OU*** `Servidor` | Nome do servidor COM, que deve Executar a função escolhida. **Exemplo:** `GeODinPlugin.GeODinPluginSample` | | `DBNode1..n` | Lista de nós incluido no gerenciador de objeto GeoDin **Bancos de dados**, Para os quais o plug-in pode ser Iniciado. Aqui você pode Selecionar, Para quais nós (ramificações e Estatuto do nó) a chamada do plug-in deve ser possível. Isso é feito ao Selecionar uma Lista de Definição de ramificação de Arbitrário Comprimento, que deve ser definido por uma Entrada `DBNodexx`. Usa os números consecutivos (`DBNode1=`, `DBNode2=` etc.) para a definição de vários nós. Veja os exemplos e a sintaxe abaixo. | | `Módulos` (opcional) | Nome do Módulos do programa no plug-in; este Nome é transferido como Parâmetro para o programa executável ou para a função COM. Se o Nome do Módulos Não for introduzido, o Parâmetro da transferência permanece Vazio. Através desta opção é possível que uma única aplicação ou função de servidor COM possa executar diferentes tarefas, que são controladas pelo Código único (ID) do Módulos. Várias funções podem ser combinadas numa aplicação externa usando Nomes de Módulos, porque é permitido ligar vários plug-ins com o mesmo Ficheiro de aplicação ou função do servidor COM. Ao transferir o Nome do Módulos como um Parâmetro diferentes Processos podem ser Ligado na aplicação ou função externa. Neste caso, diferentes funções podem ser alinhadas ao/à diferentes Símbolos usando o Parâmetro "Icon". | | `Ícone` (opcional) | Nome do ficheiro cheia de um ficheiro ICO para a visualização do Símbolo do método incluido no gestor do Método. Se este Parâmetro não for inserido, é utilizado o ícone do programa executável (não possível para servidores COM). Se o programa contém nenhum ícone, é utilizado um ícone de Texto padrão. | | `Pop-up` (opcional) | Método é exibido apenas como menu pop-up (clique com o botão direito do mouse sobre (em) o objeto incluido no gerenciador de objetos GeoDin). Defina o Valor ao `=Verdadeiro`, se o plug-in não deve aparecer como Símbolo do método, mas apenas no menu pop-up. Texto padrão o valor é `=falso` -> Símbolo incluido no gerenciador de método. | | `Aguarde` (opcional) | Controla se o GeoDin deve esperar para Executar a função no plug-in. Para aplicações (Ficheiros EXE) defina o valor para `=Verdadeiro`, se a função deve ser terminado, ao/à continuar sobre (em) trabalhando incluido GeoDin. O Texto padrão do Parâmetro deste Valor é `=falso`. ***Aviso:*** *Quando um servidor COM é utilizado, o GeoDin sempre espera até que a função termine.* | | `Permitir métodos abertos` (opcional) | Define se o plug-in pode ser executado, se houver Métodos Abrir (por ex., Coleção de dados). A configuração Padrão permite que o plug-in seja executado: defina o Parâmetro ao `=falso`, ao impedir isto (nesse caso, um Aviso será exibido). | | `ocultar` (opcional) | Controla se o plug-in fica visível no gerenciador de métodos (como Símbolo ou menu suspenso). Por Padrão, ele fica Visível. Defina o Parâmetro `ocultar` ao/à `=Verdadeiro`, ao/à ocultar o plug-in. Em seguida, o plug-in só pode ser chamado usando o [Função COM](#com-functions) **"ExecuteMethodParams"**. | | `ExecutarApósExpandir` (opcional) | Controla se o plugin é executado automaticamente ao abrir a branch pela primeira vez. Defina o Parâmetro `=Verdadeiro` ao Iniciar o plugin automaticamente. Plugins ocultos pelo Parâmetro `ocultar=Verdadeiro` pode ser Iniciado automaticamente. Desta forma, é possível chamar uma função não pelo Utilizador do GeoDin, mas que é executada automaticamente quando este ramo é aberto (por exemplo, após abrir o Banco de dados). | | `AtualizarDicionáriosDaBaseDeDados` (opcional) | Isto define, depois de o plug-in ter sido executado, se os Dicionários do Banco de dados são descarregados. Se necessário, estes serão automaticamente recarregados. | **Exemplos de DBNode** **Exemplo 1:** ``` DBNode1=3,2,1 ``` Significado: O plug-in é exibido sobre um nó de Projeto: . O Projeto: já tem de estar aberto e estar contido em um Banco de dados OneTableSet. **Exemplo 2:** ``` DBNode1=3,base de dados de furos,1 ``` Significado: O plug-in é exibido apenas sobre (em) Projetos abertos do Banco de dados "Boreholedatabase". **Exemplo 3:** ``` DBNode1=3, Base de dados de furo de sondagem,0,P00001 DBNode2=3, Base de dados de furos,0,P00002 ``` Significado: O plug-in é exibido em Projetos com o Projeto: P00001 ou P00002 do Banco de dados "Boreholedatabase". Não importa se os Projetos são abertos ou fechados. **Exemplo 4:** ``` DBNode1=9,2,0,,2,JPG ``` Significado: O plug-in é exibido incluido todos os Bancos de dados SQL com a configuração OneTableSet sobre (em) os Documentos do Típo JPG sobre (em) a Segundo Posição da Lista do Método (após o Método 'Antevisão'). **Sintaxe da definição DBNodeX=** O ID do parâmetro tem de ser inserido obrigatoriamente; os parâmetros adicionais podem ser adicionados separados por vírgulas. ``` DBNode1..n=Código único (ID)[,Param1][,Param2][,...] ``` | Código único (ID) | O plug-in é mostrado Para o objeto ... | | ----------------- | ----------------------------------------------------------- | | 1 | Bancos de dados | | 2 | Banco de dados | | 3 | Projeto: | | 4 | Consulta ou Gropo incluido o ramo Objetos | | 5 | Consulta ou Gropo incluido na ramificação Pontos de medição | | 6 | objeto | | 7 | Ponto de monitorização objeto | | 8 | Pasta de Documento | | 9 | Documento | | Parâmetro1 | O plug-in é exibido sobre (em) os Objetos definidos pelo Código único (ID) incluído em um Banco de dados incluído ... | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 0 | Todos bancos de dados | | 1 | para ID=1 o Plugin é exibido apenas se nenhum database estiver configurado atualmente; para ID=2 apenas em Bancos de dados SQL (Nenhum ficheiro-based databases) | | 2 | somente incluido em Bancos de dados SQL com a configuração OneTableSet | | Nome | apenas incluido no Banco de dados específico com o Nome inserido | | Parâmetro 2 | O plug-in é exibido No Objetos definidos pelo Código único (ID) incluído em um Banco de dados ... | | ----------- | ------------------------------------------------------------------------------------------------- | | 0 | independentemente de o Banco de dados ou o Projeto: estar aberto | | 1 | somente, se o Banco de dados ou o Projeto: estiver aberto | | 2 | somente, Se o Banco de dados ou o Projeto: estiver fechado | | Parâmetro 3 | O plug-in é exibido No Objetos definidos pelo Código único (ID) incluído em um Banco de dados ... | | ----------- | ------------------------------------------------------------------------------------------------- | | vazio | incluido todos projetos | | PRJID | apenas incluido em projetos com o Código único (ID) inserido | | Parâmetro 4 | O plug-in é mostrado incluído na Lista de Método Para uma Posição predefinida... | | ----------- | ------------------------------------------------------------------------------------------------------------- | | Vazio OU 0 | Para o Fim da Lista (depois dos Métodos do GeoDin) | | 1..n | Para a Posição inserida, por exemplo 1 - o Símbolo do método é mostrado Para o objeto sobre (em) a 1. Posição | | Param5 | O plug-in é exibido apenas para o Código único (ID)=9 sobre Documentos do seguinte tipo ... | | ------ | ------------------------------------------------------------------------------------------- | | Vazio | sobre (em) todos os tipos de documento | | JPG | apenas sobre (em) documentos deste tipo (aqui exemplo: imagens JPG) | **Usar uma aplicação (Ficheiro EXE) como plug-in** Para usar uma aplicação como plug-included, tem ao/à introduzir o parâmetro `Executar=caminho completo da aplicação` incluido na definição do plug-in. O GeoDin inicia a aplicação, quando o Método é chamado e transfere todos os Parâmetro requerido do ramo selecionado incluido no gerenciador de objeto do GeoDin. Com esses dados, o plug-in pode executar Operação executiva especiais para esses Objetos. Os Parâmetro são transferidos ao/à aplicação na Linha de comando. Dependendo sobre (em) o ramo selecionado no gerenciador de objeto do GeoDin, o Número de Parâmetro varia, o que é mostrado na Tabela a seguir: | Parâmetro | Típo | Conteúdo | Código único (ID)=1 | Código único (ID)=2 | Código único (ID)=3 | Código único (ID)=4-9 | | --------- | ------------------------ | --------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------- | ------------------- | --------------------- | | 1 | Cadeia | Nome dos Módulos OU Vazio | X | X | X | X | | 2 | Número inteiro | Posição do Ecrã à Esquerda | | X | X | X | | 3 | Número inteiro | Posição do Ecrã para cima | | X | X | X | | 4 | Número inteiro | Código único (ID) da filial | X | X | X | X | | 5 | Cadeia | Nome do banco de dados \*1 | | - | X | X | | 6 | Cadeia | Nome do registo do Banco de dados | | - | X | X | | 7 | Cadeia | Banco de dados de Palavra-passe \*2 | | - | X | X | | 8 | Cadeia | Projeto: Código único (ID) GeoDin, ou String "DB" para uma ramificação abaixo de uma Consulta em Banco de dados | | - | - | X | | 9 | String OU Número inteiro | Dependendo sobre (em) a seleção do Código único (ID) | | - | - | X | O tipo de Parâmetro 9 depende do Código único (ID) da filial, de onde o plug-in é Iniciado: | Código único (ID) | Parâmetro 9 | | ----------------- | ----------------------------------------------------------------------------------- | | 1,2,3 | vazio | | 4 | Nome do ficheiro de um ficheiro temporário com PRJ\_ID e LOCID dos Objetos | | 5 | Nome do ficheiro de um ficheiro temporário com uma cadeia dos INVIDs dos Objetos | | 6 | Código único (ID) e LOCID do selecionado objeto | | 7 | INVID do objeto selecionado como string | | 8 | Nome do ficheiro de um ficheiro temporário com inteiros dos ADC\_IDs dos Documentos | | 9 | Código único (ID) dos Documentos | \*1 Nome do banco de dados: Além do Nome do banco de dados, esta string também inclui o Típo de Conexão (ADO ou FireDAC) e a própria String de conexão. \*2 A Palavra-passe pode fazer parte da String de conexão, por ex., para Bancos de dados do Sistema ou para conexões com uma Palavra-passe armazenada. Neste caso, a string está vazia. A Palavra-passe deve ser extraída diretamente da String de conexão. {% hint style="warning" %} Se um Nome do ficheiro com os IDs dos Objetos for transferido ao/à para os plug-ins, o plug-in é responsável por Eliminar este Ficheiro! Se o Ficheiro não for eliminado, permanece na Pasta TEMP do Utilizador atual. {% endhint %} O Ficheiro com os IDs contém tantas linhas quantos Objetos estão incluido na Consulta ou Gropo. No ramo do Código único (ID) = 4, em cada linha contém o PRJID e o LOCID separados por vírgulas (Exemplo: PRJ001,3). No ramo Código único (ID) = 5, cada Linha contém o INVID (Exemplo: PRJ0010004FIL001). No branch Código único (ID) = 8 cada Linha contém o ADC\_ID (Exemplo: 23). Os Parâmetro 1 E 2 da Posição da janela "ideal" servem para Permitir ao/à posicionar a janela da aplicação externa, análoga aos Métodos GeoDin, No lado direito abaixo do Símbolo do método OU da Entrada do menu pop-up. **Usando um servidor COM como plug-incluido** ao/à Usa um servidor COM como plug-in, você tem ao/à inserir o Parâmetro `Servidor=cheia nome da interface do servidor COM` incluido na definição do plug-in. O Nome cheia consiste no Nome do servidor COM e no Nome da interface, que são separados por um Ponto, por ex. `GeODinPlugin.PluginInterface`. A interface tem de fornecer uma função com o nome `GeODinExecutePlugin`, que recebe uma string como parâmetro de transferência e retorna um parâmetro OleVariant: ``` função GeODinExecutePlugin(const Params: WideString): OleVariant; ``` ***Aviso:*** *A sintaxe da definição da função depende da linguagem de programação, incluido na qual o plug-in é criado.* A string, que é transferida em params, tem a estrutura de um Ficheiro de Configuração com as seguintes secções e Parâmetro: ``` [Parâmetro] Parâmetro Geral Esquerda= X Posição ideal de um Método, que mostra uma janela Topo= Y posição ideal de um método, que mostra uma janela Módulos= Nome dos Módulos (do GeoDin.ini) DBNode= ID of the selecionado branch SolutionNome= Nome da GeoDin-Solution (se instalado) SolutionVersion= Versão da GeoDin-Solution (se instalado) Banco de dados= Nome do banco de dados: ADOConnection Nome do usuário= Utilizador Código único (ID) Palavra-passe= Palavra-passe do Banco de dados Proprietário= Nome do proprietário da Tabela do Banco de dados PRJID= Código único (ID) ou "DB" Nome da Consulta= Nome da consulta na qual os Objetos selecionado estão incluido [Objetos] Lista dos IDs do objeto selecionado dos objetos selecionados ID1 ID2 ... [Consulta] Seção com elementos da consulta (apenas para consultas do sistema) Selecionar= Selecionar parte de um Comando SQL From= Parte FROM de um Comando SQL Where= Parte Where de um Comando SQL Order By= Parte de um Comando SQL ``` Explicação: A Posição pode ser usada pelo plug-in, ao/à Lugar um diálogo correspondente ao/à a Posição para os Métodos do GeoDin. O Parâmetro DBNode contém o Código único (ID) do ramo selecionado (consulte a Denominação do DBNode acima). A Conexão de bancos de dados é especificada pelo Nome do banco de dados (consiste em Nome e String de conexão separados por dois-pontos), Informação de login (para Bancos de dados SQL) e, eventualmente, o Nome do proprietário. O Parâmetro PRJID é ocupado pelo GeoDin código único do projeto (ID), Se os ramos selecionados estiverem sob um Projeto:, caso contrário, este Parâmetro contém a Proteger posição string "DB". Tipo de ID objeto: * Objetos: Código único (ID) PRJ\_ID e LOCID separados por vírgulas * Pontos de medição: INVID como string * Documentos: Código único (ID) dos documentos Se Consulta do sistema forem usadas, as Propriedades dos Comandos SQL, que causaram a entrada dos Objetos no gerenciador de objeto, são transferidas incluido na Seção "Consulta". O Valor de retorno da função é reservado para futuras extensões. O Valor deve ser definido ao/à ZERO, porque no momento não é retornado. **Plug-in ao/à Criar Relatório** Além da execução de plug-ins como método incluido no gerenciador de objetos GeoDin, os plug-ins também podem ser usados ao/à criar relatórios. Esse tipo de plug-ins pode ser usado incluido em layouts e gráficos ao/à realizar um tipo muito especial de relatório incluido em um gráfico. Para desenvolver um plug-in desse tipo é uma tarefa complexa, porque uma classe GeoDin incluido no formato XML precisa ao/à ser criado e devolvido como parâmetro ao/à função. Uma descrição de uma classe GeoDin incluido no formato XML não está incluída aqui (informação é fornecida sobre (em) solicitação); somente a configuração de plug-ins de relatório é descrita aqui: **1. Lista de plug-ins de Relatório — Disponível** incluido na Seção `[Plugins de Relatório]` cada plug-in é definido por uma Linha e dado um Nome. **Exemplo:** ``` [Plugins de Relatório] Plugin1=Relatório especial ``` **2. Definição de um único plug-in de relatório da Lista** Para cada plug-in definido na Lista `[Plugins de Relatório]` uma Seção separada incluido o Ficheiro de Configuração GEODIN.INI com o Nome do plug-in definido incluido no Paso 1 tem ao/à ser criado. **Exemplo:** ``` [Relatório especial] Nome=Relatório especial água Server=GeODinReportPlugin.GeODinReportPluginSample Módulos=Módulos1 ExecuteWithOutData=Falso ``` | Parâmetro | Denominação | | ------------------ | -------------------------------------------------------- | | `Nome` | Nome do Relatório Para os Elementos gráficos "Relatório" | | `Servidor` | Nome da interface do servidor COM | | `Módulos` | Nome opcional do Módulos | | `ExecutarSemDados` | Escolha / Seleção do Típo de Execução do plug-in | O Nome do Módulos é transferido ao/à o plug-in, de modo que diferentes Relatório possam ser criado incluido em uma função COM. Ao definir a opção `ExecuteWithOutData=Falso` o plug-in é Iniciado por GeoDin, Se o Gráfico for um Selecionar layout sem Conexão de dados. Ao definir a opção `ExecuteWithOutData=verdadeiro` isso só começa incluido num Gráfico com dados conectados. ao/à Usa um servidor COM como um plug-in de Relatório, insira incluido na definição do plug-in o Parâmetro `Servidor=cheia nome da interface do servidor COM`. O Nome cheia consiste no Nome do servidor COM E no Nome da interface, que são separados por vírgulas, por exemplo. `GeODinPlugin.PluginInterface`. A interface introduzida tem de fornecer uma função com o Nome `GeODinObterRelatórioGráfico`, que recebe uma string como Parâmetro de transferência e um OleVariant como Parâmetro de retorno: ``` function GeODinGetGraphicReport(const Params: WideString): OleVariant; ``` ***Aviso:*** *A sintaxe da definição da função depende da linguagem de programação, incluido na qual o plug-in é criado.* A string, que é transferida incluido params, tem a estrutura de um Ficheiro de Configuração com as secções e Parâmetros como descrito acima para os plug-ins do servidor. Como retorno, espera-se um fluxo de dados XML de acordo com a classe GeoDin C\_GraphicDrawReport. ### Números de Erro Os Números de Erro são definitivos para todos os tipos de funções. São devolvidos por [ExceptionValue](#exceptionvalue). | Número | Significado | | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 1 | Erro do Sistema (os recursos do Sistema estão esgotados, etc.) | | 2 | Função não licenciada | | 3 | Erro de inicialização (o COM-Server não foi iniciado ou foi iniciado incompletamente) | | 4 | Selecionar layout ficheiro (Parâmetro LayoutFileName) OU o layout / Relatório da Lista de layouts não pode ser carregado (Nome incorreto, ficheiro em falta, está defeituoso o.e.) | | 5 | Erro no O layout (e.g. nenhum objeto Moldura de objeto existente) | | 6 | Banco de dados não pode ser aberto (Nome do banco de dados incorreto, login incorreto) | | 7 | objeto não pode ser carregado (Projeto: Código único (ID) incorreto ou defeituoso, ID objeto, Ficheiros defeituosos incluido na Pasta GeoDin SYSLIB) | | 8 | O Ficheiro selecionado incluido no Parâmetro OutFileName não pode ser guardado (nome de ficheiro incorreto, permissões) | | 9 | O dispositivo de saída (Imprimir) selecionado está não definido, incluido no Ficheiro de Configuração GeoDin.INI. | | 10 | O dispositivo de Imprimir definido pela entrada de Configuração não pode ser encontrado incluido na Lista dos controladores de Impressora instalados. | | 11 | Erro ao criar o ficheiro para Imprimir (por exemplo, configuração incorreta do Formato do papel, o controlador da Impressora não suporta este Formato) | | 12 | Erro ao transferir o Ficheiro de Imprimir Concluído como Resultado da função (definir SpoolTimeOut) | | 13 | Não é possível criar a Entrada do objeto ou o Gropo do objeto (Código único (ID) do objeto, Típo de objeto) | | 14 | MethodID Inválido - a função não está Disponível | | 15 | Uma Escolha / Seleção não é possível porque o objeto marcado não pode ser encerrado. Exemplo: Se o objeto atual está editado e vencível ao Erro do sintaxe! incluido nos dados não pode ser Esquerda, marcar outro objeto não é possível. | | 16 | A Expressão não pode ser Iniciado porque Não há uma janela Gráfico aberta. | ## Referência: Métodos COM ### ExceptionValue Funções para identificar o estado do Erro. ``` função ExceptionValue:Número inteiro; ``` Esta função mostra o estado de Erro da função chamada anteriormente. O Valor de retorno é 0, Se a função chamada anteriormente tiver funcionado corretamente. Os possíveis números de Erro são descritos em [Números de Erro](#error-numbers). ``` função ExceptionMsg:string; ``` (Texto padrão edição requerido) Retorno do Texto de Erro de uma chamada de função previamente falhada. Se `ExceptionValue <> 0` a Anotação de Erro cheia pode ser consultada com esta função. ### objetoManagerVisible Função para mostrar ou ocultar a janela GeoDin. ``` Propriedade objetoManagerVisible:boolean ``` Ao definir esta Propriedade como "Verdadeiro" ou "Falso", a Visibilidade do gerenciador de objeto do GeoDin é controlada. ### Informação de licença. Funções para determinar a Informação de licença. ``` função LicençaInfo:string; ``` Esta função está Disponível para a edição Essentials e superiores. A resposta contém informação sobre o GeoDin e os módulos disponíveis. ``` Informação de licença. Número da compilação: G1840809 Número da dongle: desconhecido GeoDin - Edições Profissional ``` A informação da solução com número da versão continua a ser produzida, se estiverem disponíveis. ### SelecionarLocalização Funções para marcar (seleção) um objeto no gestor de objetos. ``` função SelectLocation(Banco de dados, Nome do usuário, Palavra-passe, ProjectID:Widestring; LocationID:Número inteiro):Número inteiro; ``` Esta função está Disponível a partir dos Módulos Base em diante. O objeto especificado está marcado no gerenciador de objetos do GeoDin e passa a ser o objeto atual. Como também é possível transferir o ID objeto como -1. Nesse caso, o projeto GeoDin está marcado no gerenciador de objetos e passa a ser o objeto atual. | Parâmetro | Denominação | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------ | | `Banco de dados` | Nome da Conexão de bancos de dados, por exemplo "GeoDin COM example" | | `Nome do usuário` | Nome de login do Banco de dados (para Access, um caractere de Vazio ' ', Não uma string Vazio!) | | `Palavra-passe` | Palavra-passe de início de sessão do Banco de dados (para Access, um caractere Vazio ' ', Não uma cadeia de caracteres Vazio!) | | `ID do projeto` | GeoDin código único do projeto (ID) (6 dígitos) | | `ID do objeto` | GeoDin ID objeto | {% hint style="info" %} O Valor de retorno da função é 0, Se a função for executada. O Valor de retorno é 1, Se tiver ocorrido um Erro. Veja [ExceptionValue](#exceptionvalue) E ExceptionMsg. {% endhint %} ### Selecionar objeto ``` função SelectObject(Params:Widestring):Número inteiro; ``` O objeto especificado (Banco de dados, Projeto:, Consulta, objeto, Ponto de monitorização) é marcado no gestor de objetos do GeoDin e torna-se o objeto atual. O controlo da função é acedido por uma string incluido o Formato de um Bloco de Configuração: ``` [Parâmetros] Banco de dados= Nome do usuário= Palavra-passe= Tipo do objeto= Nó pai= Consulta= ID do objeto= Expandir= ``` Os Parâmetros têm o seguinte significado: | Parâmetro | Denominação | | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Banco de dados` | Nome da Conexão de bancos de dados, por exemplo "GeoDin COM example" | | `Nome do usuário` | Nome de login do Banco de dados (para Access vazio, internamente é usado um caractere de espaço ' '!) | | `Palavra-passe` | Palavra-passe de login do Banco de dados (para Access vazio, internamente é usado um caractere de espaço ' '!) | | `Tipo de objeto` | `0` - O ramo do Banco de dados ou o ramo do Projeto: deve ser selecionado. Para selecionar o ramo do Banco de dados, o Parâmetro `Nó pai` tem de ser definido para `=Banco de dados`, os Parâmetro `Consulta` E `ID do objeto` permaneçam Vazio (Não Entrada). Para selecionar um ramo do Projeto:, o Parâmetro `Nó pai` tem de ser definido para `=Projeto:`, o Parâmetro `ID do objeto` tem ao/à de conter o Projeto: Código único (ID) (por exemplo, `ID do objeto=PRJ001`), o Parâmetro `Consulta` permanece Vazio (Não Entrada). `1` - O ramo "Objetos" ou uma Consulta de objeto deve ser selecionado. `2` - O ramo "Pontos de medição" ou uma Consulta de medição ou um Ponto de monitorização deve ser selecionado. | | `Nó pai` | `=Banco de dados`: define que o objeto ao/à ser selecionado tem de estar diretamente abaixo do Banco de dados como uma Consulta ou dentro de uma Consulta desse Típo. O Parâmetro `Consulta=` define o Nome da Consulta desse Típo. `=DatabaseQueries`: define que o objeto ao/à ser selecionado precisa estar incluido nos Objetos da ramificação (`objetoTípo=1`) ou incluido nas medições do ramo (`objetoTípo=2`) do Banco de dados. O Parâmetro `Consulta=` define o Nome da Consulta desse Típo. `=Projeto:`: define que o objeto ao/à ser selecionado tem ao/à que estar diretamente abaixo da Consulta ou dentro de uma Consulta desse Típo. O Parâmetro `Consulta=` define o Nome de uma Consulta desse Típo. `=Projeto:Consultas`: define que o objeto a ser selecionado tem que estar diretamente abaixo da Consulta ou dentro de uma Consulta desse Típo. O Parâmetro`objetoTípo=1`) ou incluido nas medições do ramo (`objetoTípo=2`) do Projeto:. O Parâmetro `Consulta=` define o Nome da Consulta. | | `Consulta` | Este Parâmetros opcionais define o Nome da Consulta a ser selecionado ou a Consulta que contém o objeto a ser selecionado. Se este Parâmetro não for inserido, o GeoDin seleciona automaticamente as consultas "Todos objetos" OU a consulta correspondente OU o tipo de medição, que é definido pelo Código único (ID) da medição (três dígitos) incluido no INVID. | | `ID do objeto` | O Parâmetro `ID do objeto` especifica o objeto escolhido. Se `ID do objeto` está vazio ou contém apenas um Código único (ID) de seis dígitos, apenas os ramos (incluido neste caso queries), que são definidos por `Nó pai` E `Consulta`, são selecionado sem selecionar um determinado objeto ou Ponto de monitorização. Um ID objeto tem de seguir diretamente o Projeto: Código único (ID) e tem de consistir numa cadeia com quatro dígitos, por exemplo `PRJ0010022` = Projeto: Código único (ID): PRJ001 e ID objeto 22. O Número do ID objeto tem ao/à ser terminado com zeros e tem ao/à consistir de exatamente quatro caracteres. Se um Ponto de monitorização tiver ao/à ser selecionado, um INVID de dezasseis dígitos tem ao/à ser introduzido, por exemplo `PRJ001022FIL001`. Uma exceção é a Escolha / Seleção de uma Consulta de ponto de medição GeoDin do Típo "Filtro" ou "Exemplo". Usando um `ID do objeto` do Típo `= PRJ001????FIL` (`objetoTípo=2`, `ParentNode=Projeto:Consultas`, `Consulta=Vazio`) por exemplo a Consulta "Filtro" incluido nos Pontos de medição do Projeto: PRJ001 pode ser selecionado sem escolher um determinado Ponto de monitorização neste ramo. | | `Expandir` | Este Parâmetro define se o ramo selecionado deve ser aberto ao mesmo tempo. Usa as entradas Para `=Verdadeiro` OU `=falso` ao/à determinar o Processo de abertura. O Texto padrão de `Expandir` é `=Verdadeiro`. | {% hint style="info" %} O valor de retorno da função é 0, Se a função foi executada. O valor de retorno é 1, Se ocorreu um Erro. Veja [ExceptionValue](#exceptionvalue) E Exceções. {% endhint %} ### CriarSeleçãoDeObjeto ``` função CreateObjectSelection(Banco de dados, Nome do usuário, Palavra-passe, ObjectIDs: WideString; ObjectType: Número inteiro; RefName: WideString; MethodID: Número inteiro; MethodParams: WideString): Número inteiro; ``` Um ou mais Objetos são adicionados ao gerenciador de Objetos GeoDin. Opcionalmente um Método com Parâmetro pode ser Iniciado Para um objeto OU um Gropo de Objetos. | Parâmetro | Denominação | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Banco de dados` | Nome da Conexão de bancos de dados, por ex. "GeoDin COM example" | | `Nome do usuário` | Nome de login do Banco de dados (para Access, um caractere de Vazio ' ', Não uma string Vazio!) | | `Palavra-passe` | Palavra-passe de início de sessão do Banco de dados (para Access, um caractere Vazio ' ', Não uma cadeia de caracteres Vazio!) | | `IDs do objeto` | Cadeia com um ou mais IDs de objeto. Estes são interpretados como Valores INVID no caso de que `Tipo de objeto = 1` OU `2`. incluido no caso de o `Tipo de objeto = 3` eles são interpretados como valores ADC\_ID. Os INVIDs podem ser obtidos a partir das tabelas LOCREG, FILREG ou PRBREG ou ser construídos de acordo ao/à as regras. Os ADC\_IDs têm de estar incluído na tabela ADC\_DATA. Ao inserir um único Código único (ID), é adicionado um único objeto e selecionado. Ao inserir vários Código único (ID)s, estes têm de ser separados por CRLF (`$0D$0A`) (objeto de lista de strings com várias linhas). Se vários objetos forem adicionados, resulta um grupo, que é selecionado após ser adicionado. | | `Tipo de objeto` | Usando `ObjectType=0` os objetos são interpretados como um objeto. Usando `objetoTípo=1` os objetos são adicionados como pontos de medição. Esta opção é especialmente relevante para os INVIDs da tabela LOCREG, porque estes podem ser objetos ou pontos de medição. Adicionar INVIDs das tabelas FILREG ou PRBREG com o `ObjectType=0` leva a um erro. Usando `ObjectType=3` documentos são adicionados e os IDs são interpretados como ADC\_IDs. | | `Nome da referência` | Se `IDs do objeto` contém apenas um objeto este Parâmetro não é utilizado. Para vários objetos este Parâmetro deve conter um nome de grupo para simplificar a Navegação do Utilizador (se uma string vazia for escolhida o grupo é chamado "Novo grupo"). | | `MethodID` | Indicação opcional de um MethodID. Inicia o método correspondente. É transferido como MethodID -1, se nenhum método for iniciado. | | `MethodParams` | É usado apenas, se `MethodID <> -1`. É usado para controlar a chamada do método. Ver [ExecuteMethodParams](#executemethodparams). | {% hint style="info" %} O Valor de retorno da função é 0, Se a função for executada. O Valor de retorno é 1, Se tiver ocorrido um Erro. Veja [ExceptionValue](#exceptionvalue) E ExceptionMsg. {% endhint %} ### MethodListAsString Funções ao/à Iniciar Métodos GeoDin. ``` função MethodListAsString:string; ``` Retorna uma lista de métodos, que podem ser chamados no objeto selecionado. A string de resultado pode consistir em várias linhas (separadas por CRLF), em que cada linha é um método. Uma entrada de método consiste no MethodID seguido por uma vírgula e o nome do método (por exemplo. `2,Editar o gráfico`"). O MethodID pode ser usado incluido o Método [Executar método](#executemethod). Se Não houver Método Disponível, a string de retorno é Vazio. ### Executar método ``` função ExecuteMethod(MethodID:Número inteiro ):Número inteiro ; ``` Esta função está disponível no módulo base GeoDin. Outros módulos podem ser necessários, dependendo do método (por exemplo, Logs, Labs...). Os MethodIDs Disponível através desta função (E através [ExecuteMethodParams](#executemethodparams)) estão documentadas em [Parâmetro do Método](#method-parameters). {% hint style="info" %} O Valor de retorno da função é 0, se a função for executada. O Valor de retorno é 1, se ocorreu um Erro. {% endhint %} ### ExecuteMethodParams ``` function ExecuteMethodParams(ID do Método: Número inteiro; Parâmetro do Método: WideString): Número inteiro; ``` Esta função está disponível no módulo base GeoDin. Outros módulos podem ser necessários, dependendo do método (por exemplo, Logs, Labs...). Inicia um Método GeoDin com Parâmetro. Os IDs válidos do Método estão descritos em [Executar método](#executemethod) e em [Parâmetro do Método](#method-parameters). {% hint style="info" %} O Valor de retorno da função é 0, se a função for executada. O Valor de retorno é 1, se ocorreu um Erro. {% endhint %} ### ObterImagem Função para criar uma Imagem. ``` function ObterImagem(const Conexão de bancos de dados, Nome do usuário, Palavra-passe, ProjectID: WideString; LocationID: Número inteiro; const Nome da Versão, Nome do Arquivo de Layout, Nome do Arquivo de Saída: WideString; Tipo de Imagem, Resolução Máxima, Compressão, Escala, Número da Página: Número inteiro; out Número de Páginas: Número inteiro): OleVariant; ``` {% hint style="info" %} **Aviso:** Esta função está Disponível apenas com uma Licença de GeoDin Server. Este recurso está Disponível nos Módulos do servidor de Imagem. {% endhint %} | Parâmetro | Denominação | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Banco de dados` | Nome da Conexão de bancos de dados, por exemplo, "GeoDin COM Example" | | `Nome do usuário` | Nome de login do Banco de dados (para Access, um caractere de Vazio ' ', Não uma string Vazio!) | | `Palavra-passe` | Palavra-passe de início de sessão do Banco de dados (para Access, um caractere Vazio ' ', Não uma cadeia de caracteres Vazio!) | | `ID do projeto` | GeoDin código único do projeto (ID) / identificação (6 caracteres) | | `ID do objeto` | ID objeto GeoDin / Número de identificação | | `Nome da versão` | Vazio string `''` ou as versões relevantes dos registos de Furo / perfil do solo e da Construção do furo a serem exibidos. Este Parâmetro é suportado apenas para Tipo de objetos da autoridade geológica regional da Baviera (Landesamt). `Nome da versão` contém uma string sem caractere de tabulação - então aqui o Nome da Versão do perfil do solo é fornecido - ou `Nome da versão` contém duas strings, conectadas por um caractere de tabulação, então isso equivale ao/à Nome da Versão do perfil do solo seguido por Nome da Versão da Construção do furo (`SVVersion+chr(9)+ASBVersion`\`). No caso do Tipo de objetos do Bavarian Landesamt, os nomes das versões são definidos pelo PKEY. | | `NomeDoArquivoDeLayout` | cheia / Nome do ficheiro completo do ficheiro de layout, por ex. `"C:\PROGRAMs\GEODIN\LAYOUTS\BOREHO1.GLO"` OU `'C:\PROGRAMDATA\GEODIN\LAYOUTS\BOHRPR1.GLO'` | | `Nome do ficheiro de saída` | Ou cadeia vazia (Nenhum ficheiro é criado) ou Nome do ficheiro cheia / completo para o Ficheiro de Imagem JPG resultante, por ex. `"C:\SAMPLE1.JPG"` | | `Tipo de imagem` | `1` (=JPG); `2` (=JPG, dados em falta ou elementos Gráfico incorretos são apresentados tracejados, como incluido na Antevisão); `11` (=PNG); `12` (=PNG, exibido tracejado); `21` (=EMF); `22` (=EMF, exibido tracejado); `31` (=WMF); `32` (=WMF, exibido com linha tracejada) | | `Resolução máxima` | Resolução: de uma Mapa de bits para o lado mais longo do Formato do papel do layout selecionado, por exemplo, 1500 | | `Compressão` | Área de Valores de 0 ao/à 100. Controla a qualidade / compressão para Imagens JPG e a velocidade / compressão para Imagens PNG. Informação detalhada é dada abaixo. | | `Escala` | Escala vertical do objeto no layout (substitui as configurações no layout; as opções "Proporcional à página" e "Correção automática." não são afetadas e podem levar a um ajuste automático da escala; as predefinições no layout "Ler de" são ignoradas). | | `Número da página` | Número da Página ao ser exibido | | `Contagem de páginas` | Retorno do Número da Página da visualização do objeto atual incluido a Escala selecionada | A função retorna a Imagem como OleVariant, de modo que não seja necessário um desvio via o OutFile. ***Aviso:*** *O Parâmetro `Compressão` não é usado por imagens EMF ou WMF durante a criação.* Se você Criar uma Imagem EMF, o Parâmetro `Resolução máxima` pode ser usado para controlar a resolução. Ao transferir 0, a resolução da imagem EMF é calculada internamente (como uma exportação direta da interface do utilizador do programa GeoDin). Se um valor `> 0` É transferida a Área horizontal Máximo da Imagem EMF, que é ajustada de modo que o Valor inserido não seja excedido. A Imagem resultante pode ter uma Área horizontal menor do que o Valor inserido, porque os Limites da Imagem EMF (Boundary box) estão alinhados aos elementos do Gráfico contidos. Devido a isso, a visualização com o mesmo Selecionar layout pode levar às Imagens EMF com uma Área horizontal diferente para diferentes Perfurações, enquanto a Área das Imagens é igual, Se Imagens de Mapa de bits forem criado. **Usando o Parâmetro Compressão:** JPG: Qualidade e compressão * 0 = baixa qualidade / alta compressão * 100 = alta qualidade / baixa compressão Tamanhos de exemplo com `ResoluçãoMáxima = 1500` para uma página A4 com o texto padrão "Perfil litológico": | Compressão | Tamanho incluido KB | Comentário | | ---------- | ------------------- | ------------------------------------- | | 0 | 48 | não utilizável | | 25 | 85 | faixas muito intensas | | 50 | 109 | faixas perceptíveis | | 75 | 135 | boa exibição | | 85 | 157 | boa exibição | | 100 | 320 | Imagem muito nítida, mas muito grande | PNG: Velocidade e compressão * 0 = muito demorado / alta compressão * 100 = muito rápido / baixa compressão | Compressão | Tamanho incluido KB | Comentário | | ---------- | ------------------- | ------------------------------- | | 0 | 42 | extremamente demorado (>30 seg) | | 25 | 72 | criação eficiente (5 seg) | | 50 | 99 | criação rápida | | 75 | 157 | criação rápida | | 75 | 564 | ficheiro muito grande | | 100 | 564 | ficheiro muito grande | Valores acima de 70 não devem ser usados; a biblioteca utilizada cria estes ficheiros PNG com defeitos esporádicos, de modo que as imagens não podem ser exibidas com todos os programas. ### GraphicLargura ``` função GraphicLargura:inteiro ``` Devolve a largura do gráfico, que foi criado quando GetImage foi chamado da última vez. A função só deve ser usada, se na aplicação chamada não houver possibilidade de chamar estes parâmetros por si próprio. ### GraphicAltura ``` função GraphicAltura:inteiro ``` Devolve a altura do gráfico, que foi criado quando GetImage foi chamado da última vez. A função só deve ser usada, se na aplicação chamada não houver possibilidade de chamar estes parâmetros por si próprio. ### GraphicPageCount ``` função GraphicPageCount:inteiro ``` Retorna o Número da Página, que foi criado quando GetImage ou GetPrintFile foi chamado da último vez. É igual ao Parâmetro de saída PageCount de Ambos as funções. A função só deve ser usada, Se a aplicação que chama não conseguir lidar com o Parâmetro de saída de Ambos as funções. ### SysInfo Função para determinar Informação do Sistema. ``` função SysInfo(Param:string):OleVariant; ``` Esta função está Disponível a partir da edição Essentials. Ela retorna Informação do Sistema dependendo do Parâmetro escolhido. Os seguintes Parâmetro estão Disponível: 1. `SysInfo(GeODinINIFileName)`: retorna o caminho completo e o nome do arquivo do GeoDin.ini atual. 2. `SysInfo(ProgramDataFolder)`: retorna o caminho dos dados do programa. 3. `SysInfo(Pasta da aplicação)`: devolve a pasta da aplicação. ## Parâmetro do Método As seções seguintes descrevem o `MethodParams` cadeias de caracteres aceitas por [Executar método](#executemethod) E [ExecuteMethodParams](#executemethodparams) para os Métodos individuais do GeoDin (identificados pelo seu MétodoID). ### Gestão de dados **MétodoID = 1 (Gestão de dados)** - `MethodParams`: A) Não há Entrada A Coleção de dados é iniciada (editor de dados gerais); Se este Método já estiver iniciado, a máscara de dados atual (Dados gerais, Dados de camadas, etc.) permanece ativa. B) Selecionar a máscara do editor desejada fornecendo uma string de dados de parâmetro da forma: ``` [Parâmetros] EditType=Número ``` Os números Disponível são: | Número | Máscara do editor | | ------ | ------------------------------------------------------------------------------------------------------------- | | 1 | Dados gerais | | 2 | Dados de camadas | | 3 | Dados de amostra | | 4 | Dados da construção do furo | | 5 | Perfilagem no furo, sondagens (sequência de dados) | | 6 | Dados adicionais, adicionalmente (1:n), dependendo do Típo de objeto, por ex., a Tabela de águas subterrâneas | ### Editar o gráfico **MethodID = 2 (Editar o gráfico)** - `MethodParams`: A) Não há Entrada A Lista de layouts padrão é aberta. O Layout atual da Lista de layouts é exibido. B) Introdução de um (layout) Nome do ficheiro, que deve apresentar o objeto. C) `"Selecionar layout:Layoutname"` A Lista de layouts padrão é aberta e O layout "layoutname" é selecionado. Opcionalmente, a Lista de layouts, que deve ser usada, pode ser descrita como caminho: ``` e.g.: "Selecionar layout:Selecionar layoutname|c:\\programs\\geodin\\syslib\\geo.gll" ``` E) `"Mensagem:Nome do Relatório"` A Lista de layouts padrão está aberta e o Relatório "reportname" está selecionado. Opcionalmente, a Lista de layouts, que deve ser usada, pode ser descrita como caminho: ``` ex.: "Mensagem:Relatórioname|c:\programme\geodin\syslib\geo.gll" ``` ### Abrir gráfico **MethodID = 4 (Abrir gráfico)** - `MethodParams`: É esperado um nome de caminho de comprimento total de um Gráfico do GeoDin, Selecionar layout ou layoutlist. O Ficheiro é aberto na janela do gráfico. ### Importar dados de medição **MethodID = 12 (Importar Valores medidos)** - `MethodParams`: ``` [Parâmetros] Banco de dados= Nome do usuário= Palavra-passe= DatType= ImpType= ImpCmdFicheiro= ImpDatFile= | ImpRepFile= ``` Os nomes dos Ficheiros são esperados como caminho completo. ``` [Fonte de dados] ImportFormat= GroupField1= GroupFieldn= ParameterField= ValueField= MesPointLink= [MesPointLink] = ... ... [ParameterLink] = ... ... [ImportOptions] AddRecords=Verdadeiro UpdateRecords=Falso SearchRecords= UpdateType= RoundNumbers=Falso CutText=falso IgnorePlausibilityErrors=falso CalcRecordChanges=Falso DetailProtocol=verdadeiro ``` ### Imprimir gráfico OU Relatório **MethodID = 13 (Imprimir gráfico OU Relatório)** - `MethodParams`: Não entrada: o impresso é feito sem uma caixa de diálogo de impressão na impressora atual. Se não houver nenhum gráfico aberto (detalhe da visualização ou resumo do quadro de layouts) ou se não houver objetos conectados com o layout no quadro de layouts, nada é impresso e o número de erro 16 é retornado. A saída de Imprimir pode, opcionalmente, ser configurada inserindo um bloco de Parâmetro: ``` [Opções de impressão] ShowImprimirDialog=Verdadeiro É exibida uma caixa de diálogo de Imprimir Dispositivo de Imprimir=Nome do Dispositivo Impressora ao Usa Nome do Ficheiro de Imprimir=Nome do Ficheiro Imprimir ao Ficheiro selecionado ``` **Nome do Dispositivo:** Para a Impressora ao Usa, incluido no GEODIN.INI deve ser introduzida uma Seção com Informação da Impressora. Exemplo: ``` [Dispositivos de Imprimir] PDF=Acrobat PDFwriter Win2PDF=Win2PDF SW=Canon GP300-405 PCL ``` Uma Denominação mais detalhada desta Seção encontra-se incluido na Informação sobre a função "GetImprimirFicheiro". `Nome do Dispositivo` tem de conter uma Entrada válida desta Seção de Configuração. **Nome do ficheiro:** Se usa o Parâmetro "PrintFileName", introduza um Nome do ficheiro cheia. Um Ficheiro eventualmente existente com o mesmo Nome é sobrescrito. Por exemplo, o bloco de Parâmetro teria o seguinte aspeto, Se quiser Usa a função Imprimir ao Criar um Ficheiro PDF: ``` [Opções de impressão] PrintDevice=Win2PDF NomeDoFicheiroDeImpressão=C:\GEODINPrints\Ausdruck1.PDF ``` ### Ativar Plug-ins **MethodID = 14 (Iniciar plug-in)** - `MethodParams`: Um Bloco de Configuração tem de ser transferido, que contém Pelo menos a Entrada: ``` [Parâmetros] Plug-incluido= ``` Como **Nome** o nome distinto da função de plug-incluido tem ao/à ser introduzido. ***Aviso:*** *O tópico aqui não é o Parâmetro "Nome", que é Visível incluido no gerenciador de objeto como o nome do* [*Plugins*](/geodin-desktop/pt/integracoes-e-plug-ins/installing-plug-ins.md)*, mas o Nome da Seção de Configuração deste plug-in. O plug-in tem ao/à ser configurado e executável para o ramo (node) atual incluído no gerenciador de objeto. Ele pode ser oculto incluído na Lista de Método em si (Parâmetro "ocultar" incluído na Configuração do plug-in).* Opcionalmente, o Bloco de Configuração pode conter outra Seção com o Nome "PluginParams" e Parâmetro Arbitrário. Exemplo: ``` [Parâmetros] Plugin=Função especial [PluginParams] Param1=Meu parâmetro 1 Param2=Meu parâmetro 2 ..... ``` Esta Seção de Configuração é transferida ao/à plug-in (apenas plug-ins de servidor COM) completamente e não é analisada pela GeoDin. Por causa disso, um Parâmetro Arbitrário pode ser transferido ao/à plug-in por chamada da função COM. ### Verificar valores medidos **MethodID = 53 (Verificar Valores medidos)** - `MethodParams`: Usa a Seção "Regressão" ao/à verificar os Valores medidos usando uma Análises de regressão. O Valor `Selecionar layout` contém o Nome do Gráfico de Regressão ao ser usado. Mais informações sobre este método podem ser encontradas no capítulo [Verificar valores medidos](/geodin-desktop/pt/analises/data-checks-and-validations.md) E incluido na Denominação [Cálculo da regressão](/geodin-desktop/pt/analises/regression-and-curve-fitting.md) do elemento de séries temporais. **Exemplo:** ``` [Regressão] Selecionar layout=AnalysisLayout1 ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.geodin.com/geodin-desktop/pt/integracoes-e-plug-ins/overview-1/method-reference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.