Funções de Imagem

PW_iPPLoadImage (Em Breve - A partir da versão 4.1.47.0)

Carrega (ou substitui) uma imagem no PIN-Pad (Abecs). (Para exibí-la, utilize a função PW_iPPDisplayLoadedImage())

👍
Int16 PW_iPPLoadImage
(Const char* pszImagePath, const char* pszImageName)

➜Entradas:

pszImagePath

Caminho da imagem, que será carregada no PIN-Pad. Exemplo: "c:\automacao\ImgIdx12.jpg".

pszImageName

Nome da imagem, que será carregada no PIN-Pad. Deve conter sempre 8 caracteres, excluindo-se a extensão, que pode ser .jpg, .png ou .gif (ver: PWINFO_PPMFSUP).Exemplos: "imagem01", "ImgIdx12" etc.

➜ Saídas:

Nenhuma.

➜ Retorno:

PWRET_OK............................Captura iniciada com sucesso, chamar PW_iPPEventLoop para obter o resultado.
PWRET_INVPARAM.............O valor de uiIndex informado não corresponde a uma captura de dados deste tipo ou a essa captura de dado não foi solicitada pela biblioteca. PWRET_DLLNOTINIT...........Não foi executado PW_iInit. Outro........................................Outro erro de execução (ver “11. Códigos de retorno”). Uma mensagem de erro pode ser obtida através da função PW_iGetResult (PWINFO_RESULTMSG).

❗️
IMPORTANTE: o nome da imagem suporta apenas caracteres numéricos e letras, sem espaços ou símbolos, e não é “case sensitive” (ou seja, os nomes “ImgAlt01” e “IMGALT01” representam o mesmo arquivo/imagem).

PW_iPPListImages (Em Breve - A partir da versão 4.1.47.0)

Obtém uma lista com o nome de todas as imagens carregadas no PIN-Pad (Abecs). (Ver: PW_iPPLoadImage()).

👍
Int16 PW_iPPListImages
(Const char* pszList, Int16 iListSize)

➜Entradas:

iListSize - Tamanho to buffer de saída (referenciado por "pszList").

➜ Saídas:

pszList - lista de nomes das imagens carregadas no PIN-Pad, com 8 caracteres cada. Exemplo: "imagem01ImgIdx12".

➜ Retorno:

PW_iPPDeleteImage (Em Breve - A partir da versão 4.1.47.0)

Apaga uma imagem do PIN-Pad (Abecs), que tenha sido previamente carregada. (Ver: PW_iPPLoadImage()).

👍
Int16 PW_iPPDeleteImage
(Const char* pszImageName)

➜Entradas:

pszImageName - Nome da imagem a ser apagada do PIN-Pad, com 8 caracteres.

➜ Saídas:

Nenhuma

➜ Retorno:

PW_iPPDisplayLoadedImage (Em Breve - A partir da versão 4.1.47.0)

Função "não blocante", que inicia a exibição de uma imagem no PIN-Pad (Abecs), previamente carregada (via PW_iPPLoadImage()). Logo em seguida, a função PW_iPPKeepDisplayImage() deve se chamada "em loop" pela aplicação, para dar continuidade à operação.

👍
Int16 PW_iPPDisplayLoadedImage
(Const char* pszImageName, Int16 iToutSec, Bool fWaitKey)

➜Entradas:

pszImageName - Nome da imagem, a ser exibida no PIN-Pad, com 8 caracteres.

iToutSec - tempo de exibição da imagem, em segundos. Se iToutSec = 0, exibe a imagem por tempo indeterminado (ou seja, nunca retorna o erro PWRET_TIMEOUT).

fWaitKey - Indica se as teclas do PIN-Pad devem ser monitoradas (exceto as numéricas).

➜ Saídas:

Nenhuma

➜ Retorno:

PWRET_OK............................Captura iniciada com sucesso, chamar PW_iPPEventLoop para obter o resultado.
PWRET_INVPARAM.............O valor de uiIndex informado não corresponde a uma captura de dados deste tipo ou a essa captura de dado não foi solicitada pela biblioteca. PWRET_DLLNOTINIT...........Não foi executado PW_iInit. PWRET_INVCALL.................. Chamada inválida Outro........................................Outro erro de execução (ver “11. Códigos de retorno”). Uma mensagem de erro pode ser obtida através da função PW_iGetResult (PWINFO_RESULTMSG).

PW_iPPKeepDisplayImage (Em Breve - A partir da versão 4.1.47.0)

Esta função deve ser chamada em "loop" (após PW_iPPDisplayLoadedImage()), para manter a imagem no display do PIN-Pad (pelo período pré-determinado), monitorar teclas do PIN-Pad (caso habilitado).

👍
Int16 PW_iPPKeepDisplayImage
(void)

➜Entradas:

Nenhuma

➜ Saídas:

Nenhuma

➜ Retorno:

PWRET_OK............................Captura iniciada com sucesso, chamar PW_iPPEventLoop para obter o resultado.
PWRET_TIMEOUT...............Tempo de espera atingido. PWRET_DLLNOTINIT.........Não foi executado PW_iInit. PWRET_PPS_OK...................Tecla ENTER (verde) pressionada no PIN-Pad.PWRET_PPS_BACKSP.........Tecla BACKSP (amarela) pressionada no PIN-Pad. PWRET_PPS_CANCEL.........Tecla CANCEL (vermelha) pressionada no PIN-Pad. PWRET_PPS_F1......................Tecla F1 pressionada no PIN-Pad. PWRET_PPS_F2.....................Tecla F2 pressionada no PIN-Pad. PWRET_PPS_F3.....................Tecla F3 pressionada no PIN-Pad. PWRET_PPS_F4.....................Tecla F4 pressionada no PIN-Pad. Outro........................................Outro erro de execução (ver “11. Códigos de retorno”). Uma mensagem de erro pode ser obtida através da função PW_iGetResult (PWINFO_RESULTMSG).

PW_iPPEndDisplayImage (Em Breve - A partir da versão 4.1.47.0)

Encerra / aborta a operação de exibição de uma imagem no PIN-Pad (Abecs). (Ver: PW_iPPDisplayLoadedImage()).

👍
Int16 PW_iPPDisplayLoadedImage
(void)

➜Entradas:

Nenuma

➜ Saídas:

Nenhuma

➜ Retorno:

PWRET_OK............................Captura iniciada com sucesso, chamar PW_iPPEventLoop para obter o resultado.
PWRET_DLLNOTINIT...........Não foi executado PW_iInit. PWRET_INVCALL.................. Chamada inválida Outro........................................Outro erro de execução (ver “11. Códigos de retorno”). Uma mensagem de erro pode ser obtida através da função PW_iGetResult (PWINFO_RESULTMSG).

❗️
IMPORTANTE: esta função SEMPRE deverá ser chamada para finalizar a operação em curso, independentemente do retorno da função PW_iPPKeepDisplayImage().

PW_iPPSetIdleImage (Em Breve - A partir da versão 4.1.47.0)

Permite definir uma imagem (ou mensagem), a ser exibida no PIN-Pad (Abecs), ao final das operações. (Ver: PW_iPPLoadImage()).

👍
Int16 PW_iPPSetIdleImage
(Const char* pszIdleImage, const char* pszIdleMsg)

➜Entradas:

pszIdleImage

Nome da imagem, com 8 caracteres, a ser exibida ao final das operações, nos PIN-Pads que suportem multimídia. (Opcional - poder ser NULL).

pszIdleMsg

Mensagem de texto, em formato livre, a ser exibida ao final das operações, nos PIN-Pads, que não suportem multimídia. O caractere 0Dh realiza a quebra de linha. (Opcional - poder ser NULL).

➜ Saídas:

Nenhuma.

➜ Retorno:

❗️
IMPORTANTE: Para exibição da imagem, esta deve ter sido previamente carregada no
PIN-Pad, através da função PW_iPPLoadImage().
Se o nome da imagem não for informado, ou ocorrer algum erro na suaexibição, a mensagem de texto será exibida.
Obs.:
❗️
Essa função não pode ser chamada várias vezes seguidas. Ela deve ser chamada uma única vez.

PW_iPPStartMenu (Em Breve - A partir da versão 4.1.47.0)

Inicia a configuração do menu, a ser exibido no PIN-Pad (Abecs), para seleção do portador. (ver: PW_iPPAddMenuOption() e PW_iPPShowMenu()).

👍
Int16 PW_iPPStartMenu
(Const char* pszMenuTitle, Int16 iToutSec)

➜Entradas:

pszMenuTitle

Título do menu. Caso não seja fornecido, o menu é apresentado sem título.

iToutSec

Tempo limite para a digitação do dado, em segundos.

➜ Saídas:

Nenhuma.

➜ Retorno:

PW_iPPAddMenuOption (Em Breve - A partir da versão 4.1.47.0)

Adiciona uma opção ao menu, que será exibido no PIN-Pad (Abecs), para seleção do portador. (ver: PW_iPPStartMenu() e PW_iPPShowMenu()).

👍
Int16 PW_iPPAddMenuOption
(Const char* pszMenuOption)

➜Entradas:

pszMenuOption

opção de menu.

➜ Saídas:

Nenhuma.

➜ Retorno:

❗️
IMPORTANTE:

A cada chamada desta função, uma nova opção é adicionada ao menu;

O menu por ter até 20 opções, para escolha do portador do cartão;

Cada opção pode ter no máximo 24 caracteres;

O menu irá apresentar as opções respeitando a ordem em que elas forem fornecidas,através desta função.

PW_iPPShowMenu (Em Breve - A partir da versão 4.1.47.0)

Inicia a configuração do menu, a ser exibido no PIN-Pad (Abecs), para seleção do portador. (ver: PW_iPPAddMenuOption() e PW_iPPShowMenu()).

👍
Int16 PW_iPPShowMenu
(Int16* piSelOption)

➜Entradas:

Nenhuma

➜ Saídas:

piSelOption - opção selecionada pelo portador (a partir de 1).

➜ Retorno:

PW_iPPEndMenu (Em Breve - A partir da versão 4.1.47.0)

Encerra / aborta o menu, exibido no PIN-Pad (Abecs).

👍
Int16 PW_iPPEndMenu
(void)

➜Entradas:

Nenuma

➜ Saídas:

Nenhuma

➜ Retorno:

❗️
IMPORTANTE: esta função SEMPRE deverá ser chamada, para finalizar a operação em curso,independentemente do retorno da função PW_iPPShowMenu().