OrdKey

OrdKey ( < cOrdem>, [ nPosicao], [ cArqIndice] ) --> 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.

• 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.

//Este exemplo, apresenta como a função OrdKey() pode recuperar a expressão da ordem atual.
USE Cliente NEW
INDEX ON Nome+Cod TO Ind1 FOR Nome+Cod > 'AZZZZZZZ'
OrdKey('Ind1')// Retorna: Nome+Cod