Realiza o parse XML de um arquivo, através do parâmetro recebido indicando o local do arquivo XML, podendo especificar a codificação do XML e opções para alterar o comportamento do parser. Se o parse for realizado com sucesso, é construida a árvore do XML.
Sintaxe
ReadFile( < cXmlFile >, [ cEncoding ], [ nOptions ] ) |
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Referência |
|---|---|---|---|---|
cXmlFile | caractere | Indica o caminho completo (a partir do rootpath) de um arquivo XML. | X |
|
cEncoding | caractere | Indica a codificação do documento. |
|
|
nOptions | numérico | Indica a combinação de opções para alterar o comportamento do parser. |
|
|
Retorno
Nome | Tipo | Descrição |
|---|---|---|
lRet | lógico | Retorna verdadeiro (.T.) caso tenha sido realizado o parse com sucesso. Caso contrário, falso (.F.). |
Observações
Tabela de valores válidos em cEncoding:
UTF-8
UTF-16
UTF-16LE
UTF-16BE
ISO-8859-1
ASCII
US-ASCII
- Os valores aceitos em nOptions são 0 (comportamento padrão, igual a função Parse) ou a soma de atributos cujo nome se incia com "Parse_".
- Caso o parâmetro <cEncoding> não seja informado, o método utilizará o encondig padrão contido no XML.
- Caso não tenha sido possível realizar o parser XML, verifique os erros ou avisos através dos métodos Error e Warning.
- Ao ser realizado o parser, automáticamente a classe irá posicionar o nó corrente no nó raiz do XML.
- O parâmetro <cXmlFile> aceita apenas caminho de arquivos do server. Caso contrário mostrará o erro "Invalid XML File – Only Server Path allowed".
- Se o arquivo apontado por <cXmlFile> não existir, será exibido o erro "Invalid XML File – File Not Found".
Exemplos
user function TXmlRead()
Local cXML := "\xml\myfile.xml"
Local oXML
oXML := TXMLManager():New()
if !oXML:ReadFile( cXML, "UTF-8", 0 )
conout( "Errors on Parse!" )
else
conout( "No errors on Parse!" )
endif
return
|