Função JetCreateIndex

Aplica-se a: Windows | Windows Server

Função JetCreateIndex

A função JetCreateIndex permite que você crie um índice de dados em um banco de dados do Mecanismo de Armazenamento Extensível (ESE), que você pode usar para localizar dados específicos rapidamente.

    JET_ERR JET_API JetCreateIndex(
      __in          JET_SESID sesid,
      __in          JET_TABLEID tableid,
      __in          JET_PCSTR szIndexName,
      __in          JET_GRBIT grbit,
      __in          const tchar* szKey,
      __in          unsigned long cbKey,
      __in          unsigned long lDensity
    );

Parâmetros

sesid

O contexto de sessão de banco de dados a ser usado para uma chamada à API específica.

Tableid

A tabela para a qual um índice será criado.

szIndexName

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome do índice a ser criado.

O nome do índice deve estar em conformidade com as seguintes diretrizes:

• Ele deve conter menos caracteres do que JET_cbNameMost, sem incluir o caractere nulo de terminação.

• Ele deve conter apenas caracteres das seguintes categorias: 0 a 9, A a Z, a a z e todos os caracteres de pontuação, exceto "!" (ponto de exclamação), "," (vírgula), "[" (colchete de abertura) e "]" (colchete de fechamento), ou seja, os caracteres ASCII 0x20, 0x22 por meio de 0x2d, 0x2f por meio de 0x5a, 0x5c e 0x5d por meio de 0x7f.

• Ele não deve começar com um espaço.

• Ele deve conter pelo menos um caractere que não seja de espaço.

grbit

Um grupo de bits que contém as opções a serem usadas para uma chamada específica. Esse parâmetro pode incluir zero ou mais das opções encontradas na estrutura JET_INDEXCREATE .

szKey

Um ponteiro para uma cadeia de caracteres terminada em nulo duplo de tokens delimitados por nulo.

Para obter mais informações sobre esse parâmetro, consulte a estrutura de JET_INDEXCREATE .

cbKey

O comprimento, em bytes, do parâmetro szKey , incluindo os dois caracteres nulos de terminação.

lDensity

A densidade percentual da árvore B+ do índice inicial.

Para obter mais informações sobre esse parâmetro, consulte a estrutura de JET_INDEXCREATE .

Valor Retornado

Essa função retorna o tipo de dados JET_ERR com um dos códigos de retorno listados na tabela a seguir. Para obter mais informações sobre os possíveis erros do ESE, consulte Erros extensíveis do mecanismo de armazenamento e parâmetros de tratamento de erros.

Código de retorno	Significado
JET_errSuccess	A operação foi concluída com sucesso.

Para obter uma lista de erros adicionais que podem ser retornados pela função JetCreateIndex , consulte JetCreateIndex2.

Comentários

Chamar a função JetCreateIndex é idêntico a chamar a função JetCreateIndex2 com uma estrutura JET_INDEXCREATE que contém as mesmas configurações que os parâmetros de JetCreateIndex e um parâmetro cIndexCreate igual a 1. Para os campos da estrutura JET_INDEXCREATE que não têm parâmetros correspondentes em JetCreateIndex, um valor de 0 é assumido.

Observe que JetCreateIndex foi substituído por JetCreateIndex2.

Requisitos

Requisito	Valor
Cliente	Requer Windows Vista, Windows XP ou Windows 2000 Professional.
Servidor	Requer o Windows Server 2008, o Windows Server 2003 ou o Windows 2000 Server.
Cabeçalho	É declarado em Esent.h.
Biblioteca	Usa ESENT.lib.
DLL	Requer ESENT.dll.
Unicode	É implementado como JetCreateIndexW (Unicode) e JetCreateIndexA (ANSI).

Consulte Também

JET_ERR
JET_GRBIT
JET_SESID
JET_TABLEID
JET_INDEXCREATE
JetCreateIndex2
JetCreateTableColumnIndex
JetCreateTableColumnIndex2