Árvore de páginas

Função: WritePProString

Permite criar e/ou alterar um seção/chave de configuração no arquivo de configuração (.INI). No entanto, caso o arquivo não exista ele será criado.

Pode-se, opcionalmente, definir um path absoluto, com unidade de disco, de modo que o arquivo de configuração (.INI) será atualizado na estação onde o TOTVS Smart Client está sendo executado.

Sintaxe

WritePProString ( < cSecao>, < cChave>, < cConteudo>, < cArqIni> ) --> lRet

Parâmetros/Elementos


NomeTipoDescriçãoObrigatórioReferência
cSecaoCaracterIndica o nome da seção, no arquivo de configuração (.INI), que será utilizada. Porém, caso a seção não exista, a mesma será criada.X
cChaveCaracterIndica o nome da chave da seção, do arquivo de configuração (.INI), que terá seu conteúdo alterado. Porém, caso a chave não exista na seção especificada, a mesma será criada.X
cConteudoCaracterIndica o conteúdo da chave que será atualizado.X
cArqIniCaracterIndica o nome do arquivo de configuração (*.INI) que será alterado. Porém, é importante observar os seguintes casos: Se o arquivo de configuração (.INI) não existir, o mesmo será criado; Se o path do arquivo de configuração (*.INI) não for informado, o mesmo será criado/atualizado no diretório onde está instalado TOTVS Application Server, no servidor; Se especificado um path absoluto, com unidade de disco, o arquivo de configuração (.INI) será criado e/ou atualizado na estação remota, no path informado.X
lRetlogico

Retorna verdadeiro (.T.) se a chave for incluída e/ou alterada com sucesso ou falso (.F.) caso ocorra alguma falha ou impossibilidade de acesso no arquivo de configuração (.INI).




Observações

As causas mais comuns de falha, no retorno da função, ocorre por erro de sintaxe no nome do arquivo e/ou path inexistente ou inacessível.


Exemplos

WritePProString('PALMJOB', 'Main', 'PalmJob', "TOTVSAPPSERVER.INI")

Veja Também


  • Sem rótulos