Funções disponíveis para uso

Estas são funções auxiliares disponíveis para uso nos plugins. Antes de utilizá-las você deve obter o endereço das mesmas conforme os códigos de exemplo.

AlocarBuffer

ProcAlocarBuffer = function(Buffer: PChar): PChar; stdcall;

AlocarBuffer := ProcAlocarBuffer(ObterFuncao('AlocarBuffer'));

typedef wchar_t* (__stdcall *ProcAlocarBuffer)(wchar_t* Buffer);

AlocarBuffer = (ProcAlocarBuffer) ObterFuncao(L"AlocarBuffer");

Objetivo

Aloca um buffer, copia os caracteres de uma string terminada em zero e retorna um ponteiro para o buffer.

O buffer retornado deverá ser desalocado usando LiberarBuffer(). Quem recebe esse buffer no retorno de uma função é que deve fazer isso.

Parâmetros

Parametro	Descrição
Buffer	Sequencia de caracteres (wide) terminada por zero.

Retorno

O novo buffer alocado com a cópia do conteúdo do buffer original.

AssinarEvento

ProcAssinarEvento = procedure (umPlugin, umEvento: PChar); stdcall;

AssinarEvento = (ProcAssinarEvento) ObterFuncao(L"AssinarEvento");

typedef void (__stdcall *ProcAssinarEvento)(wchar_t* umPlugin, wchar_t* umEvento);

AssinarEvento = (ProcAssinarEvento) ObterFuncao(L"AssinarEvento");

Objetivo

Assina um evento do Colibri. Saiba mais em Eventos disponíveis.

Esta função é recebida como parâmetro em RegistrarAssinaturas().

As assinaturas de eventos devem ocorrer durante a chamada a RegistrarAssinaturas().

Parâmetros

Parametro	Descrição
umPlugin	Nome do plugin.
umEvento	Tipo do evento assinado. Consulte Eventos do Colibri

Retorno

Sem retorno

Callback

ProcCallBack = procedure(umPlugin, umEvento, umContexto: PChar); stdcall;

CallBack := ProcCallBack(ObterFuncao('CallBack'));

typedef void (__stdcall *ProcCallBack)(wchar_t* umPlugin, wchar_t* umEvento, wchar_t* umContexto);

CallBack = (ProcCallBack) ObterFuncao(L"CallBack");

Objetivo

Permite disparar um evento de mensagem para dentro do Colibri .

Parâmetros

Parametro	Descrição
umPlugin	Nome do plugin.
umEvento	Tipo do evento.
umContexto	JSON com o conteúdo da mensagem

Retorno

Nenhum

GravarConfig

ProcGravarConfig =  procedure(umPlugin, umaConfig: PChar; idMaquina:Integer; umValor: PChar=nil); stdcall;

GravarConfig := ProcGravarConfig(ObterFuncao('GravarConfig'));

typedef void (__stdcall *ProcGravarConfig)(wchar_t* umPlugin, wchar_t* umaConfig, int idMaquina, wchar_t* umValor);

GravarConfig = (ProcGravarConfig) ObterFuncao(L"GravarConfig");

Objetivo

Grava uma configuração do plugin. As configurações ficam custodiadas no Colibri, mas devem ser mantidas pelo plugin.

Parâmetros

Parametro	Descrição
umPlugin	Nome do plugin
umaConfig	Identificador da configuração. Limite: 60 caracteres no conjunto [A-Z, a-z, 0-9, _]
idMaquina	ID da máquina a que se aplica a configuração Se for passado 0 (zero), esta configuração se aplica a todas as maquinas que utilizam o plugin
umValor	Valor da configuração. Pode-se utilizar None para apagar a configuração.

Retorno

Nenhum

GravarHistorico

ProcGravarHistorico =  procedure(plugin, operacaoId, vendaId, descricao, detalhes: PChar; funcId, funcAutorizouId: Integer); stdcall;

GravarHistorico := ProcGravarHistorico(ObterFuncao('GravarHistorico'));

typedef void (__stdcall *ProcGravarHistorico)(wchar_t* plugin, wchar_t* operacaoId, wchar_t* vendaId, wchar_t* descricao, wchar_t* detalhes, int funcId, int funcAutorizouId);

GravarHistorico = (ProcGravarHistorico) ObterFuncao(L"GravarHistorico");

Objetivo

Grava um registro na tabela de histórico da operação.

Parâmetros

Parametro	Descrição
plugin	Nome do plugin
operacaoId	Identificação da operação de venda. Este parâmetro é obrigatório pois é parte da chave primaria da tabela.
vendaId	Identificação da venda. (Este parâmetro é opcional. Usar uma string quando não for aplicável.)
descricao	Descrição do evento que gerou o histórico.
detalhes	Informações adicionais sobre o evento.
funcId	id do funcionário logado (se passar 0, assume-se o funcionário logado no POS no momento da chamada)
funcAutorizouId	id do funcionário que autorizou a ação (se passar 0, assume-se o funcionário que concedeu o privilégio no momento da chamada)

Retorno

Nenhum

LiberarBuffer

ProcLiberarBuffer = procedure(Buffer: PChar);stdcall;

LiberarBuffer := ProcLiberarBuffer(ObterFuncao('LiberarBuffer'));

typedef void (__stdcall *ProcLiberarBuffer)(wchar_t* Buffer);

LiberarBuffer = (ProcLiberarBuffer) ObterFuncao(L"LiberarBuffer");

Objetivo

Liberar um buffer alocado com AlocarBuffer

Parâmetros

Parametro	Descrição
Buffer	Buffer alocado com AlocarBuffer

Retorno

Nenhum

MostrarMensagem

ProcMostrarMensagem = function(plugin, dados:PChar): Integer; stdcall;

MostrarMensagem := ProcMostrarMensagem(ObterFuncao('MostrarMensagem'));

typedef int (__stdcall *ProcMostrarMensagem)(wchar_t* plugin, wchar_t* dados);

MostrarMensagem = (ProcMostrarMensagem) ObterFuncao(L"MostrarMensagem");

Exibe uma mensagem com o aspecto visual do Colibri.
Disponível a partir da versão 1001 do gerenciador de plugins

Parâmetros

plugin	Nome do plugin (exceto .net)
dados	JSON com os dados da mensagem

Retorno

Inteiro com o identificador do botão clicado para fechar a mensagem

Retorno	Equivale a	Descrição
1	IDOK	Botão OK
2	IDCANCEL	Botão Cancelar
6	IDYES	Botão Sim
7	IDNO	Botão Não

MostrarTeclado

ProcMostrarTeclado = function(plugin, dados:PChar): PChar; stdcall;

MostrarTeclado := ProcMostrarTeclado(ObterFuncao('MostrarTeclado'));

typedef wchar_t* (__stdcall *ProcMostrarTeclado)(wchar_t* plugin, wchar_t* dados);

MostrarTeclado = (ProcMostrarTeclado) ObterFuncao(L"MostrarTeclado");

Exibe um teclado para coletar dados com o aspecto visual do Colibri.
Disponível a partir da versão 1001 do gerenciador de plugins.

Parâmetros

plugin	Nome do plugin (exceto .Net)
dados	JSON com os dados do teclado

Retorno

JSON com os dados coletados no teclado

Chave	Tipo	Descrição
retorno	Booleano	True se o diálogo foi fechado OK False se o diálogo foi cancelado
resposta	Texto	Texto coletado no teclado, ou texto default, se cancelado.

MostrarMenu

ProcMostrarMenu = function(plugin, dados:PChar): PChar; stdcall;

MostrarMenu := ProcMostrarMenu(ObterFuncao('MostrarMenu'));

typedef wchar_t* (__stdcall *ProcMostrarMenu)(wchar_t* plugin, wchar_t* dados);

MostrarMenu = (ProcMostrarMenu) ObterFuncao(L"MostrarMenu");

Exibe um menu dinâmico para coletar uma opção numérica com o aspecto visual do Colibri.
Disponível a partir da versão 9.5.6 do Colibri POS

Parâmetros

plugin	Nome do plugin (exceto .Net)
dados	JSON com os dados do menu

Retorno

Inteiro com o índice numérico do item escolhido no menu.

ObterConfigs

ProcObterConfigs = function(umPlugin:PChar; umaMaquina:Integer): Pchar; stdcall;

ObterConfigs := ProcObterConfigs(ObterFuncao('ObterConfigs'));

typedef wchar_t* (__stdcall *ProcObterConfigs)(wchar_t* umPlugin, int umaMaquina);

ObterConfigs = (ProcObterConfigs) ObterFuncao(L"ObterConfigs");

Objetivo

Obtém todas as configurações associadas ao plugin e à maquina

Parâmetros

Parametro

Descrição

um_plugin

Nome do plugin

uma_maquina

ID da máquina.
Se for passado 0 (zero), devolve as configurações para a máquina vigente

Retorno

Retorna um JSON com as configurações do plugin para a máquina. As configurações aplicáveis a todas as máquinas também são retornadas com "maquina_id": 0.

Caso exista uma configuração com mesmo nome para todas as máquinas e para a máquina vigente, será retornada a configuração da máquina. Isto permite aplicar uma configuração para todas as máquinas e exceções por máquina.

O valor de retorno deve ser desalocado com LiberarBuffer().

{
  "configs": {
    "nome_config_1": {
      "maquina_id": 1, 
      "valor": "valor_config_1"
    },
    "nome_config_2": {
      "maquina_id": 1, 
      "valor": "valor_config_2"
    },
    "nome_todas_maquinas": {
      "maquina_id": 0, 
      "valor": "valor_config_todas_maquinas"
    }
  }
}

ObterFuncao

ProcObterFuncao = function (nomeFuncao: PChar):Pointer; stdcall;

typedef void * (__stdcall *ProcObterFuncao)(wchar_t* nomeFuncao);

Objetivo

Obtém uma função do Colibri.

Esta função é recebida como parâmetro em AtribuirObtencaoDeFuncoes().

O ponteiro desta função pode ser guardado para obter-se funções posteriormente.

Parâmetros

Parametro	Descrição
nomeFuncao	Nome da função a ser obtida

Retorno

Ponteiro da função solicitada ou nulo, caso não seja encontrada uma função com esse nome.

VerificarPermissao

ProcVerificarPermissao =  function(umPlugin, umGUIDdePermissao: PChar; deveElevar:Integer): Integer; stdcall;

VerificarPermissao := ProcVerificarPermissao(ObterFuncao('VerificarPermissao'));

typedef int (__stdcall *ProcVerificarPermissao)(wchar_t* umPlugin, wchar_t* umGUIDdePermissao, int deveElevar);

VerificarPermissao = (ProcVerificarPermissao) ObterFuncao(L"VerificarPermissao");

Objetivo

Verifica se o usuário atual tem essa permissão.

Se o usuário atual não tem permissão e o parâmetro deveElevar = 1, solicita elevação de privilégio com a digitação de outro usuário que tenha a permissão.

Parâmetros

Parametro	Descrição
umPlugin	Nome do plugin
umGUIDdePermissao	Identificador da permissão a ser testada.
deveElevar	Se for 1 indica que o sistema deve solicitar elevação para um usuário que tenha a permissão

Retorno

Retorno	Significado
1	Usuário fornecido possui a permissão
0	Usuário fornecido não possui a permissão
-1	Cancelada a digitação do usuário
-2	Erro ao obter o usuário

VerificarPermissaoEx

ProcVerificarPermissaoEx =  function(umPlugin, umGUIDdePermissao: PChar; deveElevar:Integer): PChar; stdcall;

VerificarPermissaoEx := ProcVerificarPermissaoEx(ObterFuncao('VerificarPermissaoEx'));

typedef wchar_t* (__stdcall *ProcVerificarPermissaoEx)(wchar_t* umPlugin, wchar_t* umGUIDdePermissao, int deveElevar);

VerificarPermissaoEx = (ProcVerificarPermissaoEx) ObterFuncao(L"VerificarPermissaoEx");

Objetivo

Utilize esta função em vez da anterior se precisar mais informações sobre quem esta logado e quem autorizou algum acesso. Ela é idêntica a anterior, mas retorna um json contendo mais informações.

Parâmetros

Parametro	Descrição
umPlugin	Nome do plugin
umGUIDdePermissao	Identificador da permissão a ser testada.
deveElevar	Se for 1 indica que o sistema deve solicitar elevação para um usuário que tenha a permissão

Retorno

{
  "descricao": "Permite cancelar um item",  
  "tem_permissao": true,
  "func_id": 1,
  "func_autorizou_id": 2
}

Content

Ferramentas de Espaço

Breadcrumbs

Funções disponíveis para uso

AlocarBuffer

Objetivo

Parâmetros

Retorno

AssinarEvento

Objetivo

Parâmetros

Retorno

Callback

Objetivo

Parâmetros

Retorno

GravarConfig

Objetivo

Parâmetros

Retorno

GravarHistorico

Objetivo

Parâmetros

Retorno

LiberarBuffer

Objetivo

Parâmetros

Retorno

MostrarMensagem

Parâmetros

Retorno

MostrarTeclado

Parâmetros

Retorno

MostrarMenu

Parâmetros

Retorno

ObterConfigs

Objetivo

Parâmetros

Retorno

ObterFuncao

Objetivo

Parâmetros

Retorno

VerificarPermissao

Objetivo

Parâmetros

Retorno

VerificarPermissaoEx

Objetivo

Parâmetros

Retorno