Exibir origem

API de Window para Geração de Gráficos (003)

Nome Físico: utp/wutapi011.w

Nome do Include com Parâmetros: utp/utapi011.i

Versão de Integração: 003

Objetivo:

Criação de gráficos.

Pré-requisitos:

Homologado para Windows 7 e inferiores.

Considerações Gerais

Esse programa utiliza o OCX ChartFx para geração dos gráficos, para o seu correto funcionamento é necessário instalar o OCX utilizando um dos arquivos .bat existentes no diretório interfac/chartfx do produto;
O programa pode ser executado a partir da API utapi011 ou pode ser executado diretamente por outro programa;
A include {utp/utapi011.i} contém as definições das Temp-Table´s que podem ser passadas como parâmetro para a geração dos gráficos;
Só podem ser construídos no máximo 2 gráficos na mesma aplicação, vide exemplo;
Maiores informações em relação aos valores e descrições dos atributos podem ser encontradas no HELP do Chart FX(chartfx_com_win_api.chm) que encontra-se no diretório interfac/chartfx da instalação do produto;
Para visualizar o conteúdo do arquivo chartfx_com_win_api.chm é necessário copiá-lo para um diretório local ou realizar os procedimentos descritos no endereço http://support.microsoft.com/kb/896358;
Para obter informações sobre as temp-tables que podem ser passadas como parâmetro, deve-se consultar o arquivo docapi/utapi011.doc que encontra-se no diretório de instalação do produto;
Todos os parâmetros que referem-se a cor devem utilizar os valores gerados ou pela função Progress RGB-VALUE ou pela função interna da API fnc_convColor que faz a conversão das cores disponíveis na utapi011 para o valor RGB adequado;
Sempre que o desenvolvedor optar por construir gráficos sem utilizar as temp-tables, a responsabilidade de validar os dados informados não é da API;
Todas as procedures da API retornam, através do RETURN-VALUE, “OK” quando a procedure foi executada com sucesso e “NOK” no caso de algum erro.
Existe uma limitação do componente ChartFx em relação a impressão de gráficos com o tipo “Pizza”. Os tipos de gráficos (campo GraphType) 1 e 2 não devem ser utilizados como opção inicial de impressão, deve ser utilizado outro tipo de gráfico. Caso haja a necessidade que o gráfico seja do tipo pizza, deve ser setado no desenvolvimento do programa outro tipo de gráfico e após a geração pode ser mudado o gráfico para o tipo pizza, utilizando a opção “Gallery” na guia de controle do componente.

Procedures

PI-CLEAR-DATA:

Procedure que executa o método ClearData do componente ChartFx. Dependendo do valor informado para a flag serão eliminados diferentes valores iniciais. Na seção Constantes existe a tabela de valores para ClearDataFlag, maiores informações sobre cada uma das opções pode ser consultado no manual do ChartFX. Essa procedure recebe dois parâmetros, o primeiro é o COM-HANDLE do gráfico e o segundo é um inteiro que representa a flag desejada.

Parâmetros:

  DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
  DEFINE INPUT PARAMETER iFlag AS INTEGER NO-UNDO.

Sintaxe:

RUN pi-clear-data (INPUT chGrafico, INPUT 4).

PI-CLOSEDATA:

Procedure que executa o método CloseData do componente ChartFx. Dependendo do valor informado para o código será encerrada a criação de determinados tipos de valores. Na seção Constantes existe a tabela de valores para COD, maiores informações sobre cada uma das opções pode ser consultado no manual do ChartFX. Essa procedure recebe dois parâmetros, o primeiro é o COM-HANDLE do gráfico e o segundo é um inteiro que representa o código desejado. Antes de ser executada é necessário que seja executada a procedure pi-openData com o mesmo código.

Parâmetros:

 DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
 DEFINE INPUT PARAMETER iCod AS INTEGER NO-UNDO.

Sintaxe:

RUN pi-closedata (INPUT chGrafico, INPUT 1).

PI-CRIA-INIVALUE:

Procedure que executa o método IniValue do componente ChartFx. Determina valores iniciais para os pontos do gráfico. Recebe como parâmetros o COM-HANDLE do gráfico, um inteiro que representa o número do set, um inteiro que representa o número do ponto e um decimal que é o valor inicial.

Parâmetros:

 DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
 DEFINE INPUT PARAMETER iNumSet AS INTEGER NO-UNDO.
 DEFINE INPUT PARAMETER iNumPoint AS INTEGER NO-UNDO.
 DEFINE INPUT PARAMETER dValor AS DECIMAL NO-UNDO.

Sintaxe:

RUN pi-cria-inivalue (INPUT chGrafico, INPUT 0, INPUT 0, INPUT 100.85).

PI-CRIA-LINHALIMITE:

Procedure que cria linhas constantes no gráfico, são as ConstantLines do componente ChartFX. Recebe como parâmetros o COM-HANDLE do gráfico, um char que é o label da linha, um inteiro que é o valor onde será criada a linha, um inteiro que é a cor da linha, um inteiro que é o eixo onde será criada a linha, X(2) ou Y(0), e um inteiro que é o estilo da linha. Na seção Constantes existe uma tabela com os possíveis valores para o estilo da linha.

Parâmetros:

DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER cLabel AS CHAR NO-UNDO.
    DEFINE INPUT PARAMETER iValue AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iTextColor AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iAxis AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iLineStyle AS INTEGER NO-UNDO.

Sintaxe:

RUN pi-cria-linhalimite(INPUT hGrafico,
 INPUT “Limite 01”,
 INPUT 250,
 INPUT RGB-VALUE(11,7,102),
 INPUT 0, 
 INPUT 1).

PI-CRIA-LINHASSTAT:

Procedure que cria linhas estatísticas no gráfico. Para que o desenvolvedor possa executar essa procedure é necessário que o gráfico tenha sido criado utilizando as temp-tables de comunicação. Recebe como parâmetros o COM-HANDLE do gráfico, e um inteiro que é o número do gráfico que deseja-se criar as linhas.

Parâmetros:

DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
DEFINE INPUT PARAMETER iNumGraph AS INTEGER NO-UNDO.

Sintaxe:

RUN pi-cria-linhasStat(INPUT hGrafico, INPUT 1).

PI-CRIA-PONTO:

Procedure que cria a legenda dos pontos do gráfico. Recebe como parâmetros o COM-HANDLE do gráfico, um inteiro que é o número do ponto(para cada ponto deve-se utilizar um número diferente), e um char que é o label do ponto informado.

Parâmetros:

DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
DEFINE INPUT PARAMETER iNumPoint AS INTEGER NO-UNDO.
DEFINE INPUT PARAMETER cLabel AS CHARACTER NO-UNDO.

Sintaxe:

 RUN pi-cria-ponto (INPUT chGrafico, INPUT 0, INPUT “Ponto 01”).

PI-CRIA-SET:

Procedure que cria os sets dos gráficos. Recebe como parâmetros o COM-HANDLE do gráfico, um inteiro que é o número do set (para cada set deve-se utilizar um número diferente), um char que é a legenda do set, um inteiro que é a cor do set, um inteiro que determina se serão exibidos os labels dos pontos, se for maior que 0 indica que os labels devem ser exibidos, e um inteiro que é a cor dos labels dos pontos.

Parâmetros:

 DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
 DEFINE INPUT PARAMETER iNumSet AS INTEGER NO-UNDO.
 DEFINE INPUT PARAMETER cLegend AS CHARACTER NO-UNDO.
 DEFINE INPUT PARAMETER iColor AS INTEGER NO-UNDO.
 DEFINE INPUT PARAMETER iDataLabels AS INTEGER NO-UNDO.
 DEFINE INPUT PARAMETER iDataLabelsColor AS INTEGER NO-UNDO.

Sintaxe:

 RUN pi-cria-set (INPUT hGrafico,
     INPUT hGrafico:Chart:Series:COUNT,
     INPUT "Serie " + hGrafico:Chart:Series:COUNT,
     INPUT RGB-VALUE(0,0,0),
     INPUT "",
     INPUT RGB-VALUE(0,0,0)).

PI-CRIA-STRIP:

Procedure que cria os strips dos gráficos. No ChartFX o strip é uma região destacada do gráfico, para maiores informações deve-se consultar o manual do ChartFX. Recebe como parâmetros o COM-HANDLE do gráfico, um inteiro que é o número do strip (para cada strip deve-se utilizar um número diferente), um inteiro que é o valor mínimo, um inteiro que é o valor máximo, um inteiro que é a cor do strip, e um inteiro que é o eixo onde será criada a linha, X(2) ou Y(0).

Parâmetros:

DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
DEFINE INPUT PARAMETER iStrip AS INTEGER NO-UNDO.
DEFINE INPUT PARAMETER iValueMin AS INTEGER NO-UNDO.
DEFINE INPUT PARAMETER iValueMax AS INTEGER NO-UNDO.
DEFINE INPUT PARAMETER iTextColor AS INTEGER NO-UNDO.
DEFINE INPUT PARAMETER iAxis AS INTEGER NO-UNDO.

Sintaxe:

 RUN pi-cria-strip (INPUT hGrafico,
                   INPUT 0,
                   INPUT 10,
                   INPUT 100,
                   INPUT RGB-VALUE(255,0,0),
                   INPUT 0).

PI-CRIA-TITULO:

Procedure que cria títulos nos gráficos. Recebe como parâmetros o COM-HANDLE do gráfico, um inteiro que é número do título(para cada título deve-se utilizar um número diferente), um char que é o texto do título, um char que é o nome da fonte desejada, um inteiro que é o tamanho da fonte, um inteiro que é a cor do título, um inteiro que é o alinhamento( na seção Constantes existe a tabela de valores para StringAlignment), um inteiro que é a região do gráfico onde será exibido o título( na seção Constantes existe a tabela de valores para DockArea), um lógico que determina se o título deve ser em itálico, um lógico que determina se o título deve ser em negrito, e um lógico que determina se o título deve ser sublinhado.

Parâmetros:

DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
DEFINE INPUT PARAMETER iText AS INTEGER NO-UNDO.    
DEFINE INPUT PARAMETER cText AS CHAR NO-UNDO.    
DEFINE INPUT PARAMETER cFontName AS CHAR NO-UNDO.    
DEFINE INPUT PARAMETER iFontSize AS INTEGER NO-UNDO.    
DEFINE INPUT PARAMETER iTextColor AS INTEGER NO-UNDO.    
DEFINE INPUT PARAMETER iAlignment AS INTEGER NO-UNDO.    
DEFINE INPUT PARAMETER iDockArea AS INTEGER NO-UNDO.    
DEFINE INPUT PARAMETER lItalic AS LOGICAL NO-UNDO.    
DEFINE INPUT PARAMETER lBold AS LOGICAL NO-UNDO.    
DEFINE INPUT PARAMETER lUnderline AS LOGICAL NO-UNDO.

Sintaxe:

RUN pi-cria-titulo (INPUT chGrafico,
                    INPUT 0,      
                    INPUT “Título”,          
                    INPUT “Arial”,           
                    INPUT 10,                
                    INPUT RGB-VALUE(0,0,0),  
                    INPUT 1,             
                    INPUT 1,             
                    INPUT False,           
                    INPUT True,           
                    INPUT False).

PI-CRIA-VALUE:

Procedure que executa o método Value do componente ChartFx. Determina os valores dos pontos do gráfico. Recebe como parâmetros o COM-HANDLE do gráfico, um inteiro que representa o número do set, um inteiro que representa o número do ponto e um decimal que é o valor.

Parâmetros:

    DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER iNumSet AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iNumPoint AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER dValor AS DECIMAL NO-UNDO.

Sintaxe:

RUN pi-cria-value (INPUT chGrafico, INPUT 0, INPUT 0, INPUT 128).

PI-FORMAT-LEGEND:

Procedure que formata as legendas do gráfico. Recebe como parâmetros o COM-HANDLE da legenda, um char que é o nome da fonte, um inteiro que é o tamanho da fonte, um inteiro que é a cor, um lógico que determina se a legenda deve ser em itálico, um lógico que determina se a legenda deve ser em negrito, e um lógico que determina se a legenda deve ser sublinhada.

Parâmetros:

    DEFINE INPUT PARAMETER hLegend AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER cFontName AS CHAR NO-UNDO.
    DEFINE INPUT PARAMETER iFontSize AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iTextColor AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER lItalic AS LOGICAL NO-UNDO.
    DEFINE INPUT PARAMETER lBold AS LOGICAL NO-UNDO.
    DEFINE INPUT PARAMETER lUnderline AS LOGICAL NO-UNDO.

Sintaxe:

    RUN pi-format-legend (INPUT chGrafico:Chart:AxisX,
                          INPUT “Arial”,
                          INPUT 10,
                          INPUT RGB-VALUE(0,255,0),
                          INPUT True,
                          INPUT False,
                          INPUT False).

PI-FORMAT-SERIES:

Procedure que formata as séries do gráfico. Recebe como parâmetros o COM-HANDLE da série, um inteiro que se for maior que 0 informa que devem ser exibidos os labels dos pontos, e um inteiro que é a cor.

Parâmetros:

    DEFINE INPUT PARAMETER chSeries AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER iDataLabels AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iDataLabelsColor AS INTEGER NO-UNDO.

Sintaxe:

    RUN pi-format-series (INPUT hGrafico:Chart:Series(0),
                          INPUT 1,
                          INPUT RGB-VALUE(0,0,255)).

PI-GET-CHARTHANDLE:

Procedure que retorna o handle do gráfico desejado. Com essa funcionalidade o desenvolvedor possui toda liberdade para utilizar os recursos do componente mesmo que não sejam disponibilizados via API. Recebe como parâmetro um valor inteiro que indica o handle do gráfico que será retornado. Se for informado 1 será retornado o handle do gráfico 1 e se for diferente de 1 será retornado o handle do gráfico 2. Essa procedure tem um parâmetro de OUTPUT que é do tipo COM-HANDLE, e contém o handle do gráfico desejado.

Parâmetros:

    DEFINE INPUT  PARAMETER iChart AS INTEGER NO-UNDO.
    DEFINE OUTPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.

Sintaxe:

    RUN pi-get-chartHandle (INPUT 1, OUTPUT hGrafico).

PI-INICIALIZAR:

Procedure que faz a criação dos gráficos quando os dados são inseridos através das temp-tables que são utilizadas na utapi011. Quando essa procedure é executada a mesma realiza o processo de validação dos dados, assim como é feito na utapi011. Se existir alguma falha será retornado “NOK” e a temp-table tt-erros conterá os registros dos erros. Essa procedure só deve ser executada pelo desenvolvedor no momento em que desejar exibir os dados e não for mais necessário alterar nenhum informação. Não recebe nem retorna nenhum tipo de parâmetro.

PI-OPENDATA:

Procedure que permite ao desenvolvedor iniciar a criação dos pontos no gráfico. Após executar essa procedure e não se deseja criar mais pontos é necessário executar a procedure pi-closeData com o mesmo código informado nessa procedure. Na seção Constantes existe a tabela de valores para COD, maiores informações sobre cada uma das opções podem ser consultadas no manual do ChartFX. Recebe como parâmetro o COM-HANDLE do gráfico, um inteiro que representa o código do tipo de dados que se deseja criar, um inteiro que determina o número de séries do gráfico, e um inteiro que determina o número de pontos de cada série. É importante esclarecer que no componente ChartFX todas as séries devem possuir o mesmo número de pontos.

Parâmetros:

    DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER iCod AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iSerie AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iPoints AS INTEGER NO-UNDO.

Sintaxe:

    RUN pi-openData(INPUT hGrafico,
                    INPUT 1,
                    INPUT 2,
                    INPUT 5).

PI-SET-CHART-OPTIONS:

Procedure que define algumas características gerais do gráfico. Recebe como parâmetro o COM-HANDLE do gráfico, um char que determina a fonte do gráfico, um inteiro que define o tamanho da fonte, um inteiro que se for maior que 0 determina que as linhas do gráfico serão espessas, um lógico que determina que os textos devem ser em itálico, um lógico que determina que os textos devem ser em negrito, e um lógico que determina que os textos devem ser sublinhados.

Parâmetros:

    DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER cFontName AS CHAR NO-UNDO.
    DEFINE INPUT PARAMETER iFontSize AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iThickLines AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER lItalic AS LOGICAL NO-UNDO.
    DEFINE INPUT PARAMETER lBold AS LOGICAL NO-UNDO.
    DEFINE INPUT PARAMETER lUnderline AS LOGICAL NO-UNDO.

Sintaxe:

    RUN pi-set-chart-options (INPUT chGrafico,
                              INPUT “Arial”,
                              INPUT 10,
                              INPUT 1,
                              INPUT False,
                              INPUT False,
                              INPUT True).

PI-SET-CHART-TYPE:

Procedure que determina o tipo do gráfico. Recebe como parâmetro o COM-HANDLE do gráfico, e um inteiro que é o tipo do gráfico. Na seção Constantes existe a tabela de valores para Gallery, maiores informações sobre cada uma das opções pode ser consultado no manual do ChartFX.

Parâmetros:

    DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER iGraphType AS INTEGER NO-UNDO.

Sintaxe:

 RUN pi-set-chart-type (INPUT chGrafico,
                        INPUT 2).

PI-SET-CHARTBORDER:

Procedure que determina o tipo de borda do gráfico. Recebe como parâmetro o COM-HANDLE do gráfico, e um inteiro que é o tipo da borda do gráfico. Na seção Constantes existe a tabela de valores para BorderType, maiores informações sobre cada uma das opções pode ser consultado no manual do ChartFX.

Parâmetros:

    DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER iGridStyle AS INTEGER NO-UNDO.

Sintaxe:

    RUN pi-set-chartBorder ( INPUT chGrafico,
                             INPUT 21).

PI-SET-GRID:

Procedure que determina o grid do gráfico. Recebe como parâmetro o COM-HANDLE do gráfico, um inteiro que é o estilo do grid (1 para grid horizontal, 2 para grid vertical e 3 para ambos), e um inteiro que é o estilo da linha do grid. Na seção Constantes existe a tabela de valores para DashStyle, maiores informações sobre cada uma das opções podem ser consultadas no manual do ChartFX.

Parâmetros:

    DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER iGridStyle AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iGridLineStyle AS INTEGER NO-UNDO.

Sintaxe:

    RUN pi-set-grid (INPUT chGrafico,
                     INPUT 3,
                     INPUT 3).

PI-SET-GRID-AXIS:

Procedure que cria o grid para um determinado eixo do gráfico. Recebe como parâmetro o COM-HANDLE do axis desejado, e um inteiro que é o estilo da linha do grid. Na seção Constantes existe a tabela de valores para DashStyle, maiores informações sobre cada uma das opções podem ser consultadas no manual do ChartFX.

Parâmetros:

    DEFINE INPUT PARAMETER hAxis AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER iGridLineStyle AS INTEGER NO-UNDO.

Sintaxe:

    RUN pi-set-grid-axis (INPUT hGrafico:Chart:AxisX,
                          INPUT 2).

PI-SET-LOGBASE:

Procedure que determina se um determinado eixo do gráfico está com base logarítmica. Recebe como parâmetro o COM-HANDLE do gráfico, um inteiro que é o eixo que deve estar na base logarítmica (1 – apenas o eixo Y, 2 – apenas o eixo X e 3 – para ambos), e um inteiro que é o valor da base logarítmica.

Parâmetros:

    DEFINE INPUT PARAMETER hGrafico AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER iAxis AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iLogBase AS INTEGER NO-UNDO.

Sintaxe:

    RUN pi-set-logbase(INPUT chGrafico,
                       INPUT 1,
                       INPUT 10).

PI-SET-VISIBLE:

Procedure que passa exibe ou esconde os gráficos. Recebe como parâmetro um inteiro e de acordo com o seu valor os gráficos serão exibidos ou escondidos. Para um valor menor ou igual a 0 os dois gráficos serão escondidos, para o valor 1 apenas o gráfico 1 será exibido, para o valor 2 apenas o gráfico 2 será exibido e para um valor maior ou igual a 3 os dois gráficos serão exibidos.

Parâmetros:

    DEFINE INPUT PARAMETER iGrafico AS INTEGER NO-UNDO.

Sintaxe:

    RUN pi-set-visible (INPUT 3).

PI-SETA-ESTILO-LEGENDBOX:

Procedure que determina o estilo da legendbox. Recebe como parâmetro o COM-HANDLE do gráfico, um char que é o nome da fonte desejada, um inteiro com o tamanho da fonte, um inteiro com a posição da legenda (ver na seção Referências a tabela de posição da legenda), um lógico que determina que os textos devem ser em itálico, um lógico que determina que os textos devem ser em negrito, e um lógico que determina que os textos devem ser sublinhados.

Parâmetros:

    DEFINE INPUT PARAMETER hGrafico         AS COM-HANDLE NO-UNDO.
    DEFINE INPUT PARAMETER cLegendFontName  AS CHAR NO-UNDO.
    DEFINE INPUT PARAMETER iLegendFontSize  AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER iLegendPos       AS INTEGER NO-UNDO.
    DEFINE INPUT PARAMETER lItalic AS LOGICAL NO-UNDO.
    DEFINE INPUT PARAMETER lBold AS LOGICAL NO-UNDO.
    DEFINE INPUT PARAMETER lUnderline AS LOGICAL NO-UNDO.

Sintaxe:

    RUN pi-seta-estilo-legendBox (INPUT chGrafico,
                                  INPUT “Arial”,
                                  INPUT 10,
                                  INPUT 1,
                                  INPUT True,
                                  INPUT True,
                                  INPUT False).

Funções

FNC_CONVSTYLE:

Função que converte o valor inteiro, da tabela de tipos de fontes da utapi011, para true ou false dependendo do valor informado e do tipo de fonte. Recebe como parâmetro um valor inteiro que é o código da tabela do tipo de fontes, e um valor do tipo char que representa que estilo estamos analisando (pode ser igual a: “Italic”, “Bold” ou “Underline”). Retorna um valor do tipo lógico.

Parâmetros:

    INPUT iStyle AS INTEGER
    INPUT cType AS CHARACTER

Sintaxe:

fnc_convStyle(3, “Italic”)

Parâmetros de entrada

Temp table tt-atributos

TEMP-TABLE tt-atributos
Atributo	Tipo	Formato	Valor Inicial
NumGraph	Integer		1
Cod-Versao-Integracao	Integer
GraphTitle	Character
GraphTitleColor	Integer
GraphType	Integer
GraphStyle	Integer
LabelsColor	Integer
LeftTitle	Character
LeftTitleStyle	Integer		0
LeftTitleColor	Integer
BottomTitle	Character
BottomTitleColor	Integer
DataLabels	Integer		0
DataLabelsColor	Integer		?
LimitLines	Integer		0
LimitLinesColor	Integer
LimitHighLabel	Character
LimitLowLabel	Character
LimitHighValue	Decimal
LimitLowValue	Decimal
LineStats	Integer
MeanLineColor	Integer
MinMaxLinesColor	Integer
StDevLinesColor	Integer
BestFitLinesColor	Integer
CurveType	Integer
CurveColor	Integer
ThickLines	Integer
GridStyle	Integer		0
GridLineStyle	Integer		0
TitleFontName	Character		Arial
TitleFontSize	Integer		200
TitleFontStyle	Integer		0
OtherFontName	Character		Arial
OtherFontSize	Integer		150
OtherFontStyle	Integer		0
LabelFontName	Character		Arial
LabelFontSize	Integer		100
LabelFontStyle	Integer		0
LegendFontName	Character		Arial
LegendFontSize	Integer		100
LegendFontStyle	Integer		0
LegendPos	Integer		0

Atributo	Descrição
NumGraph	Identifica o gráfico a que pertencem os atributos do registro. (1 ou 2)
Cod-Versao-Integracao	Indica a versão atual da API
GraphTitle	Título do Gráfico.
GraphType	Tipo do gráfico. *Ver tabela Tipos de gráficos
GraphStyle	Estilo do Gráfico. *Ver tabela Estilos de Gráficos
LabelsColor	Cor dos Labels do gráfico. *Ver Tabela de Cores
LeftTitle	Título do eixo das Ordenadas (Y)
LeftTitleStyle	Estilo do título do eixo das ordenadas (Y). *Ver tabela Estilos do Título das Ordenadas
LeftTitleColor	Cor do título do eixo das Ordenadas (Y). *Ver tabela de Cores
BottomTitle	Título do eixo das Abscissas (X)
BottomTitleColor	Cor do título das Abscissas(X). *Ver Tabela de Cores
DataLabels	Habilita a visualização de labels de valores para todos os gráficos do tipo 2D exceto para o tipo Pizza. *Ver Tabela de Labels de Valores
DataLabelsColor	Cor dos labels de valores. *Ver Tabela de Cores.
LimitLines	Linhas que definem limites no gráfico.
LimitLinesColor	Cor das linhas de limites. *Ver Tabela de Cores
LimitHighLabel	Label da linha de limite superior
LimitLowLabel	Label da linha de limite inferior
LimitHighValue	Valor para a linha de limite superior
LimitLowValue	Valor para a linha de limite inferior
LineStats	Define linhas estatísticas. *Ver Tabela de Linhas de Estatística
MeanLineColor	Cor da linha de meio. *Ver Tabela de Cores
MinMaxLinesColor	Cor das linhas de valores máximo e mínimo. *Ver Tabela de Cores
StDevLinesColor	Cor da linha de desvio padrão. *Ver Tabela de Cores
BestFitLinesColor	Cor das linhas de nível. *Ver tabela de Cores
CurveType	Tipo de Curvas. LineStats deve possuir valor entre 16 e 31. *Ver Tabela de Curvas
CurveColor	Cor da curva. *Ver Tabela de Cores
ThickLines	Linhas espessas (1) ou não (0 default)
GridStyle	Estilo do Grid do gráfico.
GridLineStyle	Estilo da linha do Grid do gráfico.
TitleFontName	Nome da fonte do Título.
TitleFontSize	Tamanho da fonte do Título.
TitleFontStyle	Estilo da fonte do título do gráfico. *Ver tabela estilo de fontes.
OtherFontName	Nome da fonte das strings que não pertencem aos títulos.
OtherFontSize	Tamanho da fonte das strings que não pertencem aos títulos.
OtherFontStyle	Estilo da fonte das strings que não pertencem aos títulos. *Ver tabela estilo de fontes.
LabelFontName	Nome da fonte dos Labels.
LabelFontSize	Tamanho da fonte dos Labels.
LabelFontStyle	Estilo da fonte do título dos Labels. *Ver tabela estilo de fontes.
LegendFontName	Nome da fonte das Legendas.
LegendFontSize	Tamanho da fonte das Legendas.
LegendFontStyle	Estilo da fonte do título das Legendas. *Ver tabela estilo de fontes.
LegendPos	Posição das legendas do gráfico. *Ver tabela de Posições da Legenda.
LeftTitleStyle	Estilo da fonte das Legendas. *Ver tabela Estilo de Legendas.

Temp-table tt-points-2: Na Temp-Table tt-points são definidas as características comuns aos points do gráfico. Um point refere-se a um período do gráfico, ou seja, ao intervalo entre dois valores do eixo X. Também é fundamental que a cada novo set, o valor do campo NumPoint inicie em 1

TEMP-TABLE tt-points-2
Atributo	Tipo	Formato	Valor Inicial
NumPoint	Integer
NumGraph	Integer		1
LabelText	Character		“”

Atributo	Descrição
NumPoint	Número do Point.
NumGraph	Identifica a qual gráfico pertencem os atributos do registro.
LabelText	Label do Point.

Temp-table tt-sets: Na Temp-Table tt-sets são definidas as características dos sets do gráfico. Um set refere-se aos valores representados em um point. Existe limite de valores para o número de sets em relação ao tipo de gráfico, para maiores informações sobre estas limitações consulte o HELP do Chart FX(chartfx_com_win_api.chm) que encontra-se no diretório interfac/chartfx da instalação do produto.

TEMP-TABLE tt-sets
Atributo	Tipo	Formato	Valor Inicial
NumSet	Integer
NumGraph	Integer		1
LegendText	Character
ColorSet	Integer

Atributo	Descrição
NumSet	Número do Set.
NumGraph	Identifica a qual gráfico pertencem os atributos do registro.
LegendText	Legenda do Set.
ColorSet	Cor do Set. *Ver tabela de Cores.

TEMP-TABLE tt-reuniao
Atributo	Tipo	Formato	Valor Inicial
i-versao-integracao	integer	">>9"
c-assunto	Char
c-corpo	Char
c-local	Char
c-categoria	Char
dt-dataini	Date	“99/99/9999”
dt-horaini	Char
l-lembrete	Logical		No
l-diatodo	Logical		No
i-duracao	Integer	“9999”
i-horaaviso	Integer
i-tipohorario	integer
c-convidadosreq	Char
c-convidadosopc	Char
c-convidadosrec	Char
i-importancia	Integer
i-tipo	Integer
l-periodico	Logical		No
i-tipoperiodo	Integer
i-intervalo	Integer
i-diassemana	Integer
i-mesdoano	Integer
i-diadomes	Integer
dt-fimperiodico	date
i-inicioocorrencia	integer
i-ocorrencias	integer

* ver Principais Validações da Temp-Table tt-reuniao

Atributo	Descrição
i-versao-integracao	Campo usado para verificar compatibilidade entre programa e api
c-assunto	Campo referente ao assunto do compromisso
c-corpo	Texto que seguira junto com o compromisso, é o corpo da mensagem
c-local	Local do compromisso
c-categoria	Categorias que o compromisso pertence separadas por “;”
dt-dataini	Data inicial do compromisso em formato mm/dd/yyyy
c-horaini	Hora de início do compromisso em formato hh:mm:ss
i-lembrete	Define se deve ser habilitado o lembrete para aviso prévio do compromisso
i-diatodo	Define se o compromisso ocupa todo o dia (hora de início deve ser informada)
i-duracao	Duração, em minutos, do compromisso.
i-horaaviso	Define o tempo, em minutos, para aviso prévio antes do compromisso (a função lembrete deverá estar ativada)
i-tipohorario	Define como deve ser mostrado o horário 0-Disponível 1-Provisório 2- Ocupado 3-Fora do escritório
c-convidadosreq	Convidados requeridos separados por “;”, podendo ser usado o nome do catálogo de endereços ou endereço de e-mail. *
c-convidadosopc	Convidados opcionais separados por “;”, podendo ser usado o nome do catálogo de endereços ou endereço de e-mail.*
c-convidadosrec	Convidados do tipo recurso separados por “;”, podendo ser usado o nome do catálogo de endereços ou endereço de e-mail. *
i-importancia	Importância da reunião 0-baixa 1-normal 2-alta
i-tipo	Tipo do compromisso 0-normal 1-pessoal 2-privado 3-confidencial.
i-periodico	Define se o compromisso é do tipo periódico, ou seja, se o mesmo tem várias ocorrências. **
i-tipoperiodo	Define o tipo de período a ser usado no compromisso.**
i-intervalo	Define o intervalo entre as ocorrências, como 2 meses 3 dias dependendo do tipo da mesma. **
i-diassemana	Máscara que define o(s) dias(s) de semana a serem usados para o compromisso. **
i-mesdoano	Define o mês de 1 a 12 para o compromisso. **
i-diadomes	Define o dia do mês para o compromisso. **
dt-fimperiodico	Data do fim das ocorrências de um compromisso periódico, sobrescreve o valor da variável i-ocorrências. **
i-inicioocorrencia	Define o dia de início de ocorrência para certos tipos de períodos como terceira (segunda) de cada mês. **
i-ocorrencias	Número de ocorrências de um compromisso periódico. **

*O contato deverá existir no catálogo de endereços

** Verificar tópico referente a compromissos periódicos em “Outras informações”.

Temp-table tt-dados: Informações referentes aos dados do gráfico. Um dado do gráfico deve estar obrigatoriamente relacionado a um point e a um set, portanto para que um registro da tt-dados exista, devem existir relacionamentos com a tt-points e tt-sets. Ou seja, um dado deve pertencer a um point e a um set. Também é fundamental que a cada novo set, o valor do campo NumPoint inicie em 1.

TEMP-TABLE tt-dados
Atributo	Tipo	Formato	Valor Inicial
NumGraph	Integer		1
NumPoint	Integer
NumSet	Integer
GraphData	Decimal		0

Atributo	Descrição
NumGraph	Identifica a qual gráfico pertencem os atributos do registro.
NumPoint	Número do Point.
NumSet	Número do Set.
GraphData	Valor do dado do gráfico.

Temp-table tt-erros: A tt-erros é uma tabela de retorno de dados referentes aos erros encontrados na manipulação dos dados das tabelas de entrada. A tt-erros retorna dados através de um registro contendo o código do erro e a sua descrição.

Obs.: Após a chamada feita à API é imprescindível tratar os erros retornados caso existam.

TEMP-TABLE tt-erros
Atributo	Tipo	Formato	Valor Inicial
Cod-Erro	Integer
Desc-Erro	Character

Atributo	Descrição
Cod-Erro	Número do erro. Seqüencial dentro da temp-table.
Desc-Erro	Descrição do erro.

Execução

A geração de gráficos pode ser feita de duas maneiras:

Aprimeira é criando as informações nas temp-tables da mesma maneira como é feito para a utapi011. Após criar as informações nas temp-tables é necessário executar a API de forma persistente, executar as procedures que passam as temp-tables para a API e por último executar a procedure pi-inicializar.

Sintaxe:

Def var hwutapi011 as handle no-undo.
RUN utp/wutapi011.w PERSISTENT SET hwutapi011.
RUN pi-set-tt-atributos IN hwutapi011(INPUT TABLE tt-atributos).
RUN pi-set-tt-points-2 IN hwutapi011 (INPUT TABLE tt-points-2).
RUN pi-set-tt-sets IN hwutapi011 (INPUT TABLE tt-sets).
RUN pi-set-tt-dados IN hwutapi011 (INPUT TABLE tt-dados).
RUN dispatch IN hwutapi011 (INPUT "INITIALIZE").
RUN pi-inicializar IN hwutapi011.
IF RETURN-VALUE = "NOK" THEN DO:
RUN pi-get-tt-erros IN hwutapi011(OUTPUT TABLE tt-erros).
      DELETE OBJECT hwutapi011.
      RETURN "NOK".
END.
IF VALID-HANDLE(hwutapi011) THEN DO:
WAIT-FOR CLOSE OF hwutapi011. 
END.
IF VALID-HANDLE(hwutapi011) THEN DO:
DELETE OBJECT hwutapi011.
END.

{utp/utapi011.i}

/*IF  OPSYS = "MSDOS" THEN DO:*/
IF  OPSYS = "WIN32" THEN DO:
    Create tt-atributos.
    Assign tt-atributos.cod-versao-integracao = 3
           tt-atributos.graphtype             = 7
           tt-atributos.graphtitle            = 'Gráfico 1.'
           tt-atributos.lefttitle             = 'Valores 1.'
           tt-atributos.lefttitlestyle        = 1  
           tt-atributos.bottomtitle           = 'Faixas 1.'
           tt-atributos.numgraph              = 1.

    Create tt-atributos.
    Assign tt-atributos.cod-versao-integracao = 3
           tt-atributos.graphtype             = 7
           tt-atributos.graphtitle            = 'Gráfico 2.'
           tt-atributos.lefttitle             = 'Valores 2.'
           tt-atributos.lefttitlestyle        = 1  
           tt-atributos.bottomtitle           = 'Faixas 2.'
           tt-atributos.numgraph              = 2.
    
    Create tt-sets.
    Assign tt-sets.NumSet   = 1 
           tt-sets.NumGraph = 1
           tt-sets.ColorSet = 11
           tt-sets.legendText = "SET 1".
   
    Create tt-sets.
    Assign tt-sets.NumSet   = 2
           tt-sets.NumGraph = 1
           tt-sets.ColorSet = 12
           tt-sets.legendText = "SET 2".

    create tt-points-2.
    assign tt-points-2.NumPoint  = 1
           tt-points-2.NumGraph  = 1
           tt-points-2.labeltext = "Point 1".
    create tt-points-2.
    assign tt-points-2.NumPoint  = 2 
           tt-points-2.NumGraph  = 1
           tt-points-2.labeltext = "Point 2".

    Create tt-dados.
    Assign tt-dados.NumPoint   = 1
           tt-dados.NumSet     = 1
           tt-dados.NumGraph   = 1
           tt-dados.graphdata  = 1000.
    Create tt-dados.
    Assign tt-dados.NumPoint   = 2
           tt-dados.NumSet     = 1
           tt-dados.NumGraph   = 1
           tt-dados.graphdata  = 2000.

    Create tt-dados.
    Assign tt-dados.NumPoint   = 1
           tt-dados.NumSet     = 2
           tt-dados.NumGraph   = 1
           tt-dados.graphdata  = 1500.
    Create tt-dados.
    Assign tt-dados.NumPoint   = 2
           tt-dados.NumSet     = 2
           tt-dados.NumGraph   = 1
           tt-dados.graphdata  = 2250.

    /*Segundo Gráfico*/
    Create tt-sets.
    Assign tt-sets.NumSet   = 3
           tt-sets.NumGraph = 2
           tt-sets.ColorSet = 11
           tt-sets.legendText = "SET 3".
   
    Create tt-sets.
    Assign tt-sets.NumSet   = 4
           tt-sets.NumGraph = 2
           tt-sets.ColorSet = 12
           tt-sets.legendText = "SET 4".

    create tt-points-2.
    assign tt-points-2.NumPoint  = 1
           tt-points-2.NumGraph  = 2
           tt-points-2.labeltext = "Point 4".
    create tt-points-2.
    assign tt-points-2.NumPoint  = 2
           tt-points-2.NumGraph  = 2
           tt-points-2.labeltext = "Point 5".
    
    Create tt-dados.
    Assign tt-dados.NumPoint   = 1
           tt-dados.NumSet     = 3
           tt-dados.NumGraph   = 2
           tt-dados.graphdata  = 3000.
    Create tt-dados.
    Assign tt-dados.NumPoint   = 2
           tt-dados.NumSet     = 3
           tt-dados.NumGraph   = 2
           tt-dados.graphdata  = 2000.
    
    Create tt-dados.
    Assign tt-dados.NumPoint   = 1
           tt-dados.NumSet     = 4 
           tt-dados.NumGraph   = 2
           tt-dados.graphdata  = 500.
    Create tt-dados.
    Assign tt-dados.NumPoint   = 2 
           tt-dados.NumSet     = 4
           tt-dados.NumGraph   = 2
           tt-dados.graphdata  = 250.
    
Def var hwutapi011 as handle no-undo.

RUN utp/wutapi011.w PERSISTENT SET hwutapi011.
RUN pi-set-tt-atributos IN hwutapi011(INPUT TABLE tt-atributos).
RUN pi-set-tt-points-2 IN hwutapi011 (INPUT TABLE tt-points-2).
RUN pi-set-tt-sets IN hwutapi011 (INPUT TABLE tt-sets).
RUN pi-set-tt-dados IN hwutapi011 (INPUT TABLE tt-dados).
RUN dispatch IN hwutapi011 (INPUT "INITIALIZE").
RUN pi-inicializar IN hwutapi011.

IF RETURN-VALUE = "NOK" THEN DO:
RUN pi-get-tt-erros IN hwutapi011(OUTPUT TABLE tt-erros).
      DELETE OBJECT hwutapi011.
END.

IF VALID-HANDLE(hwutapi011) THEN DO:
WAIT-FOR CLOSE OF hwutapi011.            
END.
IF VALID-HANDLE(hwutapi011) THEN DO:
DELETE OBJECT hwutapi011.
END.

END.

if return-value = "NOK" then do: 
    for each tt-erros: 
        disp cod-erro desc-erro FORMAT "x(100)" with 1 col width 500. 
    end.
end.

A segunda maneira de criar os gráficos é o desenvolvedor executar diretamente os métodos da API. Nesse caso não será realizada nenhuma validação.

Sintaxe:

Def var hwutapi011 as handle no-undo.
RUN utp/wutapi011.w PERSISTENT SET hwutapi011.
RUN dispatch IN hwutapi011 (INPUT "INITIALIZE").
IF VALID-HANDLE(hwutapi011) THEN DO:
WAIT-FOR CLOSE OF hwutapi011. 
END.
IF VALID-HANDLE(hwutapi011) THEN DO:
DELETE OBJECT hwutapi011.
END.

Def var hwutapi011 as handle no-undo.
DEFINE VARIABLE hGrafico AS COM-HANDLE  NO-UNDO.

RUN utp/wutapi011.w PERSISTENT SET hwutapi011.
RUN dispatch IN hwutapi011 (INPUT "INITIALIZE").
RUN pi-get-charthandle IN hwutapi011 (INPUT 1, OUTPUT hGrafico).
RUN pi-set-chartBorder IN hwutapi011 ( INPUT hGrafico, INPUT 21).
RUN pi-showtips IN hwutapi011 (INPUT hGrafico,INPUT FALSE ).
RUN pi-clear-data IN hwutapi011 (INPUT hGrafico,INPUT 4). 
RUN pi-cria-titulo IN hwutapi011 (INPUT hGrafico,
                                  INPUT 0,
                                  INPUT "Titulo",
                                  INPUT "Arial",
                                  INPUT 10,
                                  INPUT RGB-VALUE(0,0,0),
                                  INPUT 1,
                                  INPUT 1,
                                  INPUT FALSE,
                                  INPUT TRUE,
                                  INPUT FALSE).                  
RUN pi-cria-titulo IN hwutapi011 (INPUT hGrafico,
                                  INPUT 1,
                                  INPUT "Titulo Esq.",
                                  INPUT "Arial",
                                  INPUT 8,
                                  INPUT RGB-VALUE(0,0,0),
                                  INPUT 1,
                                  INPUT 0,        
                                  INPUT FALSE,
                                  INPUT TRUE,
                                  INPUT FALSE).
RUN pi-cria-titulo IN hwutapi011 (INPUT hGrafico,
                                  INPUT 2,
                                  INPUT "Titulo Inf.",
                                  INPUT "Arial",
                                  INPUT 8,
                                  INPUT RGB-VALUE(0,0,0),
                                  INPUT 1,
                                  INPUT 3,
                                  INPUT FALSE,
                                  INPUT TRUE,
                                  INPUT FALSE).
RUN pi-seta-estilo-legendBox IN hwutapi011 (INPUT hGrafico,
                                            INPUT "Arial",
                                            INPUT 10,
                                            INPUT 1,
                                            INPUT FALSE,
                                            INPUT FALSE,
                                            INPUT FALSE).    

/*Formata as legendas do eixo X*/
RUN pi-format-legend IN hwutapi011 (INPUT hGrafico:Chart:AxisX,
                                    INPUT "Arial",
                                    INPUT 10,
                                    INPUT RGB-VALUE(255,0,0),
                                    INPUT FALSE,
                                    INPUT FALSE,
                                    INPUT FALSE).
/*Formata as legendas do eixo Y*/
RUN pi-format-legend IN hwutapi011 (INPUT hGrafico:Chart:AxisY,
                                    INPUT "Arial",
                                    INPUT 10,
                                    INPUT RGB-VALUE(255,0,0),
                                    INPUT FALSE,
                                    INPUT FALSE,
                                    INPUT FALSE).
/*Determina as demais formatações do gráfico*/
RUN pi-set-chart-options IN hwutapi011 (INPUT hGrafico, 
                                        INPUT "Arial", 
                                        INPUT 10,
                                        INPUT 0,
                                        INPUT FALSE,
                                        INPUT FALSE,
                                        INPUT FALSE).  

/*Seta o grid para o gráfico*/
RUN pi-set-grid IN hwutapi011 (INPUT hGrafico,
                               INPUT 0,
                               INPUT 0).

/*Determina se o Gráfico é 3D*/
RUN pi-set-chart-3d IN hwutapi011 (INPUT hGrafico,INPUT NO).
RUN pi-set-chart-type IN hwutapi011 (INPUT hGrafico,INPUT 1).

RUN pi-cria-set IN hwutapi011 (INPUT hGrafico,
                               INPUT 0,
                               INPUT "Set 01",
                               INPUT RGB-VALUE(0,255,0),
                               INPUT 0,
                               INPUT RGB-VALUE(0,0,0)).
RUN pi-cria-set IN hwutapi011 (INPUT hGrafico,
                               INPUT 1,
                               INPUT "Set 02",
                               INPUT RGB-VALUE(0,0,255),
                               INPUT 0,
                               INPUT RGB-VALUE(0,0,0)).

RUN pi-cria-ponto IN hwutapi011 (INPUT hGrafico,
                                 INPUT 0,
                                 INPUT "Ponto 01").
RUN pi-cria-ponto IN hwutapi011 (INPUT hGrafico,
                                 INPUT 1,
                                 INPUT "Ponto 02").

/*Aqui inicia o processo de criação dos pontos no gráfico. Os que não existirem terão valor 0*/
RUN pi-openData IN hwutapi011 (INPUT hGrafico,
                               INPUT 1,
                               INPUT 2,
                               INPUT 2).
RUN pi-cria-value IN hwutapi011 (INPUT hGrafico,
                                 INPUT 0,
                                 INPUT 0,
                                 INPUT 1000).  
RUN pi-cria-value IN hwutapi011 (INPUT hGrafico,
                                 INPUT 0,
                                 INPUT 1,
                                 INPUT 2000). 
RUN pi-cria-value IN hwutapi011 (INPUT hGrafico,
                                 INPUT 1,
                                 INPUT 0,
                                 INPUT 1500).  
RUN pi-cria-value IN hwutapi011 (INPUT hGrafico,
                                 INPUT 1,
                                 INPUT 1,
                                 INPUT 2250).
RUN pi-closeData IN hwutapi011 (INPUT hGrafico,
                                INPUT 1). 
RUN pi-set-visible IN hwutapi011 (INPUT 1).
IF VALID-HANDLE(hwutapi011) THEN DO:
WAIT-FOR CLOSE OF hwutapi011.            
END.
IF VALID-HANDLE(hwutapi011) THEN DO:
DELETE OBJECT hwutapi011.
END.

Referências

No retorno da execução do utp/wutapi011.p, será retornado um dos valores via RETURN-VALUE:

NOK:

Retorna o código e a descrição do erro.

OK:

O gráfico será exibido através do programa utp/wutapi011.w, que roda na mesma seção Progress do programa que executou a API. O programa que executou a utapi011 ficará aguardando o encerramento do programa wutapi011.w para encerrar sua execução.

No caso do retorno ser NOK, todos os erros encontrados serão retornados através da Temp-Table tt-erros.

Outras Informações

Compromissos periódicos:

Os compromissos periódicos podem ser dos seguintes tipos:

Mensal com início de ocorrência (3):

Os compromissos do tipo mensal com início de ocorrência são executados de n em n meses conforme a variável i-intervalo no primeiro, segundo, terceiro, quarto ou ultimo dia da ocorrência do dia definido na variável i-diassemana conforme a variável i-inicioocorrencia.
Exemplo da definição de um compromisso mensal com início de ocorrência:
assign i-tipoperiodo = 3 /* define o tipo do período como mensal com início de ocorrência */ i-intervalo = 4 i-diassemana = 1 i-inicioocorrencia = 2.
Desta forma será agendado um compromisso do tipo mensal com início de ocorrência que acontece de 4 em 4 meses no segundo domingo do mês.
No caso particular de compromissos com início de ocorrência, deve se levar em consideração que a variável i-diassemana deverá conter o valor de apenas um dia da semana ou então o valor 127 para o primeiro dia, o valor 65 para o primeiro dia de fim de semana ou 62 para o primeiro dia útil. Note que 127 é a soma de todos os dias da semana, 65 é a soma de sábado e domingo e 62 e a soma de segunda a sexta, estes são os únicos valores somados permitidos para esse tipo de ocorrência exclusivamente.

Anual com início de ocorrência (6):

Os compromissos do tipo anual com início de ocorrência ocorrem 1 vez por ano no mês n conforme a variável i-mesdoano, no primeiro, segundo, terceiro, quarto ou ultimo dia da ocorrência do dia definido na variável i-diassemana conforme a variável i-inicioocorrencia.
Exemplo da definição de um compromisso anual com início de ocorrência:
assign i-tipoperiodo = 6 /* define o tipo do período como anual */ i-mesdoano = 5 i-diassemana = 16 i-inicioocorrencia = 2.
Desta forma será agendado um compromisso do tipo anual com início de ocorrência que acontece no mês 5 na segunda quinta-feira. Os valores da variável i-diassemana são os mesmos do tipo de período 3.

Definições das Temp-Tables a serem utilizadas pela API utp/utapi028.p

Definição Temp-Table tt-reuniao:

DEFINE TEMP-TABLE tt-reuniao
    field i-versao-integracao AS INTEGER FORMAT ">>9" 
    field c-assunto           AS CHAR
    FIELD c-corpo             AS CHAR
    FIELD c-local             AS CHAR
    FIELD c-categoria         AS CHAR
    FIELD dt-dataini          AS DATE FORMAT "99/99/9999"
    FIELD c-horaini           AS CHAR
    FIELD l-lembrete          AS LOGICAL INIT NO
    FIELD l-diatodo           AS LOGICAL INIT NO
    FIELD i-duracao           AS INTEGER FORMAT "9999"
    FIELD i-horaaviso         AS INTEGER
    FIELD i-tipohorario       AS INTEGER
    FIELD c-convidadosreq     AS CHAR
    FIELD c-convidadosopc     AS CHAR
    FIELD c-convidadosrec     AS CHAR
    FIELD i-importancia       AS INTEGER
    FIELD i-tipo              AS INTEGER
    FIELD l-periodico         AS LOGICAL INIT NO
    FIELD i-tipoperiodo       AS INTEGER
    FIELD i-intervalo         AS INTEGER
    FIELD i-diassemana        AS INTEGER
    FIELD i-mesdoano          AS INTEGER
    FIELD i-diadomes          AS INTEGER
    FIELD dt-fimperiodico     AS DATE
    FIELD i-inicioocorrencia  AS INTEGER
    FIELD i-ocorrencias       AS INTEGER.

Exemplo de Utilização

{utp/utapi028.i}
CREATE tt-reuniao.
ASSIGN c-assunto = "Assunto da mensagem"
       c-corpo = " Aqui vai um grande texto para o corpo da mensagem"
       c-local = " Local qualquer"
       dt-dataini = 12/23/2002
       l-lembrete = FALSE
       c-horaini = "00:00:00"
       l-diatodo = FALSE
       i-duracao = 800
       i-horaaviso = 50
       i-importancia = 0 
       i-tipohorario = 3 
       c-convidadosreq = "[email protected]"
       c-convidadosopc = "João da Silva"
       c-convidadosrec = "Luiz Cesar Medeiros Filho;Joao da Silva"
       i-tipo =2
       c-categoria = "Importante"
/* inicia periódico */
       l-periodico = TRUE
       i-tipoperiodo = 1
       i-diassemana = 127
       i-inicioocorrencia = 2
       i-intervalo = 2.

run utp/utapi028.p persistent set h-utapi028.
run pi-execute in h-utapi028 (input table tt-reuniao,output table tt-erros).
for each tt-erros:
        disp "Erro: " tt-erros.cod-erro skip
             "Descrição: " tt-erros.desc-erro format "x(50)".
end.

delete procedure h-utapi028.

Possíveis erros

Erro 4786: Hora informada não está correta!

Erro ocasionado quando o campo c-horaini não é preenchido corretamente, ou seja não contém uma hora no formato HH:MM:SS, ou seu tamanho não tem 8 caracteres, ou a hora informada é maior que 23, os minutos informados maiores que 59 ou os segundos informados também maiores que 59.
Deve ser também levado em consideração que uma hora do tipo 2:29:35 está errada pois seu formato é H:MM:SS e não corresponde ao formato solicitado pela api. O correto seria 02:29:35.

API de Window para Geração de Gráficos (003)

Considerações Gerais

Procedures

Funções

Parâmetros de entrada

Execução

Referências

Outras Informações

Definições das Temp-Tables a serem utilizadas pela API utp/utapi028.p

Exemplo de Utilização

Possíveis erros

Erro 4786: Hora informada não está correta!

Erro 26816: Um ou mais convidados estão incorretos