Descrição
OrdKey [AS] - Verifica qual a expressão de chave da ordem.
|
Sintaxe
| OrdKey( <cOrdem | nPosicao>, <cArqIndice> ) |
Parâmetros
| Par |
Nome |
Tipo |
Descrição |
Default |
Obg |
Ref |
01
|
cOrdem
|
Caracter
|
Indica o nome do índice (Tag).
|
|
|
|
| 02 |
nPosicao
|
Numérico
|
Indica a ordem numérica do índice
|
Corrente
|
|
|
| 03 |
cArqIndice
|
Caracter
|
Indica o nome do arquivo de índice (Bagname)
|
|
|
|
Retorno
| Retorno |
Tipo |
Descrição |
| cRet |
Caracter
|
Retorna a expressão de chave da ordem ativa ou especificada pelos parâmetros. Se o retorno for uma string vazia, significa que não existe ordem corrente.
|
Exemplo
#INCLUDE "TOTVS.CH"
User Function OrdKey()
dbSelectArea('SA1')
MsgInfo( OrdKey(1), 'UniversoADVPL' )
Return( Nil )
Resultado
Informações adicionais
|
Essa função é utilizada para verificar qual é a expressão de chave de determinada ordem
|
|
Caso os parâmetros de identificação da ordem não sejam especificados, será verificada a ordem corrente
|
|
Para evitar conflito, se houver mais de uma ordem com o mesmo nome, pode-se passar o parâmetro com o nome do índice ao qual a ordem pertence
|
|
A ordem passada, no primeiro parâmetro <nOrdem> ou <nPosicao>, pode ser especificada através da sua posição na lista de ordens ativas (através da OrdListAdd) ou do nome dado à ordem. Pois, a função verifica automaticamente se o parâmetro é numérico ou caracter
|
Gostou? Compartilhe com seus amigos e deixe um comentário! 😎