Recupera o conteúdo de uma chave de configuração, do ambiente em uso, no arquivo de configuração (.INI) do TOTVS Application Server.
Sintaxe
GetSrvProfString( < cChave >, < cDefault > )
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Referência |
---|---|---|---|---|
cChave | caractere | Indica a chave que deve ser lida do arquivo de configuração. | X |
|
cDefault | caractere | Indica o conteúdo da chave a ser retornada, caso a chave não seja encontrada. | X |
|
Retorno
Nome | Tipo | Descrição |
---|---|---|
cRet | caractere | Retorna o conteúdo da chave especificada. Caso a chave não seja encontrada na seção de configuração do ambiente atual, a função retornará o conteúdo informado no parâmetro cDefault. |
Observações
Tamanho máximo do conteúdo de uma chave: Ao configurar um conteúdo em uma chave em um arquivo .ini, o conteúdo nao deve ultrapassar 254 caracteres. Caso seja informado em qualquer seção do arquivo de configuração uma chave com mais de 254 caracteres no seu conteúdo, a leitura desta chave somente vai retornar os primeiros 254 caracteres da chave.
Exemplos
User Function Exemplo() Local cMensagem := "" //+----------------------------------------------------------------------------+ //|Exemplifica o uso da função GetSrvProfString | //+----------------------------------------------------------------------------+ cMensagem += "StartPath atual: " + GetSrvProfString("StartPath", "\undefined") //+----------------------------------------------------------------------------+ //|Apresenta uma mensagem com os resultados obtidos | //+----------------------------------------------------------------------------+ Return MsgInfo(cMensagem, "Exemplo do GetSrvProfString")
Preview
Exemplo da função GetSrvProfString()