Usina BRAdvPL Guia
Entrar
← Todos os tópicos
FUNçãOEm revisão

IndexKey

IndexKey([nOrdem]) -> cExpr

Obtém a expressão de uma chave de índice.

IndexKeyAdvPL
01 · VISÃO GERAL

Visão geral

nOrdem zero ou omitido consulta o índice corrente; uma ordem sem índice retorna string vazia. Área não aberta pode gerar Work area not in use. A expressão retornada descreve a chave e não é o valor da chave no registro. (Fontes: refs. 1–1.) O exemplo comunitário de posicionamento também ilustra GetArea/RestArea e seleção explícita de índice; não determina a ordem de todos os ambientes.

02 · SINTAXE

Sintaxe

IndexKey([nOrdem]) -> cExpr

Parâmetros

nOrdem
NuméricoOpcional

Ordem; zero ou omitido indica a corrente.

Retorno

Expressão de chave ou string vazia.

03 · EXEMPLO PRÁTICO

Exemplo comentado

#Include "Protheus.ch"

User Function Ed486()
    // Somente consulta, sem criar ou trocar indices.
    If !Empty(Alias())
        ConOut(cValToChar(IndexKey(0)))
    EndIf
Return Nil
Resultado esperado

Informa metadado da área corrente quando houver área aberta. Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

BOAS PRÁTICAS
  • Não usar texto de expressão de fonte não confiável em macroexecução. Verificar a ordem efetiva antes de DbSeek.
  • Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

Conteúdos relacionados

REFERÊNCIAS
  1. TOTVS. IndexKey. TDN. Consulta em 2026-10-27.
  2. Daniel Atilio. zIndPos.prw; commit 7d275a7. Consulta em 2026-10-27.
Situação
Em revisão
Página criada em
Última revisão em
Idioma original
Português
Revisão
Usina.BR
0 comentário(s) aprovado(s)

Comentários

Ainda não há comentários aprovados.

Entre com Google ou Microsoft para comentar.

Powered by Usina Docs · Alpha