CeGetDatabaseProps (EDB)

9/8/2008

Essa função obtém algumas ou todas as propriedades de um banco de dados.

Essa função não trabalho com bancos de dados CEDB. Para obter mais informações sobre CEDB, consulte CEDB Reference.

Syntax

BOOL CeGetDatabaseProps (
  HANDLE hDatabase,
  LPWORD lpcPropID,
  CEPROPID* prgPropID,
  CEPROPSPEC* prgProps
);

Parameters

• hDatabase
  [no] Identificador para um aberto banco de dados. Esse identificador é obtido por chamado a função CeOpenDatabaseInSession (EDB).

• lpcPropID
  [in, Out] Número de identificações de propriedade na prgPropID matriz.

• prgPropID
  [no] Ponteiro para uma matriz de propriedade IDs que especifica as propriedades a serem recuperados. Se este parâmetro for definido como NULL a primeira *lpcPropID Propriedades são retornadas. Isso permite que propriedades a ser retornado sem saber a propriedade identificações.

• prgProps
  [in, Out] Matriz de CEPROPSPEC (EDB) em que a propriedade informações é ser colocado. Se o valor deste parâmetro for definido como NULL, o número de propriedades no banco de dados é retornado no *lpcPropID. O chamador deve definir a wVersion valor dos elementos de prgProps Para CEPROPSPEC_VERSION antes chamado essa função.

  O pwszPropName campo de CEPROPSPEC Deve ser definido para apontar para uma reserva seqüência vazia para Pre-allocate espaço para nomes propriedade.

Return Value

TRUE indica sucesso. FALSE indica falha. Para informações de erro estendidas get, chamar GetLastError. A seguinte tabela mostra os valores possíveis.

Return valor	Descrição
ERROR_INSUFFICIENT_BUFFER	Não há memória suficiente disponível para um dos nomes de propriedade.
ERROR_INVALID_HANDLE	O hDatabase parâmetro for definido como NULL ou igual a INVALID_HANDLE_VALUE.
ERROR_INVALID_PARAMETER	Indica um do seguinte: O lpcPropID parâmetro for definido como NULL. Qualquer um dos elementos no prgProps Não é necessário wVersion Igual a _VERSION CEPROPSPEC.

Remarks

Esta função pode ser usada para executar qualquer um do seguinte operações:

• Para obter o número de propriedades de um banco de dados. Definir prgProps para NULL.
• Selecione apenas um subconjunto das propriedades. Definir as identificações propriedade exigida em prgPropID.
• Return as propriedades, mesmo se suas identificações de propriedade não são conhecidas. Definir prgPropID para NULL.

Se algum das propriedades especificadas na prgPropID Não existe no banco de dados, o correspondente posiciona em prgProps Define o wVersion valor para zero.

Propriedades são adicionadas a um banco de dados usando a função CeAddDatabaseProps (EDB) e removidas usando a função CeRemoveDatabaseProps (EDB).

Requirements

Header	windbase.h
Library	coredll.lib
Windows Embedded CE	Windows CE 5.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later

See Also

Reference

EDB Functions
CeOpenDatabaseInSession (EDB)
CeAddDatabaseProps (EDB)
CeRemoveDatabaseProps (EDB)
CEPROPSPEC (EDB)