Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico | ipp/ipapi009.p |
Objetivo
Exportar para o formato do MS Excel as informações geradas em um componente de OCX Tree-list, gerando as informações em forma de árvore. O arquivo Excel gerado será semelhante ao exemplo a seguir:
Pré-Requisito
O computador deverá ter instalado o MS Excel.
Funcionamento
A API deve ser executada diretamente, passando-se alguns parâmetros pré-definidos.
A sintaxe para chamada da api é a seguinte:
run ipp/ipapi009.p (input <com-handle>,
input <character>,
input <logical>,
input <logical>,
input <integer>).
Descrição Parâmetros
Parâmetros | Descrição |
p-chComponente | Com-handle do componente OCX TreeList |
p-cNovoArquivo | Caminho e nome do arquivo onde o xls será criado. Pode ser o caminho relativo ou absoluto |
p-arvore | Lógico – indica se o arquivo será gerado com a formação de árvore, conforme o que foi gerado do TreeList. |
p-pinta-linha | Lógico – indica se a exportação será feita seguindo o mesmo padrão de formatação e cores do TreeList, ou se será exportado somente as informações sem formatação, que é mais performático. |
p-versao | Caso o índice da formação do treelist esteja no padrão (i1, i2, i3, etc..), então deve ser passado neste parâmetro o valor 1, que faz um processamento bem mais rápido, confiando no índice sequencial do treelist. Entretanto, caso o índice do treelist esteja em outro padrão qualquer, deve ser passado neste parâmetro o valor 2. Neste caso, apesar de ser menos performático, a exportação será feita sem restrições. |