Função: GetMv - Dicionário de parâmetros
Abrangências: |
Protheus 10
|
Versões: |
Advanced Protheus 5.07
,
Advanced Protheus 5.08
,
Advanced Protheus 6.09
,
Advanced Protheus 7.10
,
Microsiga Protheus 8.11
,
Protheus 10
|
Compatível Países: |
Todos
|
Sistemas Operacionais: |
Todos
|
Compatível às Bases de Dados: |
Todos
|
Nível de Acesso: |
Nível 1 (Acesso Clientes)
|
Idiomas: |
Espanhol
,
Inglês
|
Descrição:
Verifica se um parâmetro existe no Dicionário de Parâmetros (SX6) ou retorna seu conteúdo dependendo dos parâmetros informados à função.
Sintaxe:
GetMv - Dicionário de parâmetros (
cMv_par [
lConsulta ] [
xDefault ] )
--> xConteudo
Retorno:
xConteudo(qualquer)
- O retorno depende do tipo do parâmetro cadastrado no SX6 e de como os parâmetros lConsulta e xDefault foram informados:- se lConsulta for informado como verdadeiro o retorno será um valor lógico indicando se o parâmetro existe;- se xDefault for informado e o parâmetro nao existe, o retorno será o valor informado em xDefault;- caso contrário retorna o conteúdo do parâmetro
Exemplos
Local cVar // quando existe o parametro criadocVar := GetMv( "MV_SIGALOG" , .F. , ) // retorna o conteudo do parametrocVar := GetMv( "MV_SIGALOG" , .F. , "Teste" ) // retorna o conteudo do parametrocVar := GetMv( "MV_SIGALOG" , .T. , ) // retorna .T.cVar := GetMv( "MV_SIGALOG" , .T. , "Teste" ) // retorna o conteudo do parametro//nao existe o parametro e for executado pela rotina auto cVar := GetMv( "MV_SIGALOG" , .F. , ) // retorna .F. e gera log na systemcVar := GetMv( "MV_SIGALOG" , .F. , "Teste" ) // retorna Teste cVar := GetMv( "MV_SIGALOG" , .T. , ) // retorna .F. cVar := GetMv( "MV_SIGALOG" , .T. , "Teste" ) // retorna Teste // nao existe o parametro e acessa pelo remotecVar := GetMv( "MV_SIGALOG" , .F. , ) // retorna .F. e exibe msg de helpcVar := GetMv( "MV_SIGALOG" , .F. , "Teste" ) // retorna TestecVar := GetMv( "MV_SIGALOG" , .T. , ) // retorna .F. cVar := GetMv( "MV_SIGALOG" , .T. , "Teste" ) // retorna Teste
Parâmetros:
| Nome | | | Tipo | | | Descrição | | | Default | | | Obrigatório | | | Referência | |
| cMv_par | | | Caracter | | | Nome do parametro. | | | | | | X | | | | |
| lConsulta | | | Lógico | | | Se for .T.: se o valor xDefault não for informado, retorna se o parâmetro existe(.T.) ou não(.F.). Se xDefault for informado, retorna seu conteudo caso não exista o parâmetro. Não gera log ou mensagem de help. Se for .F.: retorna .F. e gera log (batch) na pasta do sistema ou help(remote), caso o parâmetro não existir e não for informado o valor xDefault. Se for informado o valor xDefault, retorna o seu conteudo e não gera log ou help.Valor padrão é falso. | | | Falso | | | | | | | |
| xDefault | | | Qualquer | | | Valor padrão que deve ser retornado quando o parâmetro não existir. O valor desse parâmetro pode ser Caracter, Numérico, Lógico ou Data. | | | | | | | | | | |
|