Función MsiDatabaseGetPrimaryKeysA (msiquery.h)

  • Artículo

La función MsiDatabaseGetPrimaryKeys devuelve un registro que contiene los nombres de todas las columnas de clave principal de una tabla especificada. Esta función devuelve un identificador que se debe cerrar mediante MsiCloseHandle.

Sintaxis

UINT MsiDatabaseGetPrimaryKeysA(
  [in]  MSIHANDLE hDatabase,
  [in]  LPCSTR    szTableName,
  [out] MSIHANDLE *phRecord
);

Parámetros

[in] hDatabase

Identificador de la base de datos. Consulte Obtención de un identificador de base de datos.

[in] szTableName

Especifica el nombre de la tabla de la que se van a obtener los nombres de clave principales.

[out] phRecord

Puntero al identificador del registro que contiene los nombres de clave principales.

Valor devuelto

Esta función devuelve UINT.

Comentarios

El recuento de campos del registro devuelto es el recuento de columnas de clave principal devueltas por la función MsiDatabaseGetPrimaryKeys . El registro devuelto contiene el nombre de la tabla en Field (0) y los nombres de columna que componen los nombres de clave principal en los campos correctos. Estos nombres de clave principal corresponden a los números de columna de los campos.

Esta función no se puede usar con la tabla _Tables ni la tabla _Columns.

Tenga en cuenta que se recomienda usar variables de tipo PMSIHANDLE porque el instalador cierra los objetos PMSIHANDLE a medida que salen del ámbito, mientras que debe cerrar objetos MSIHANDLE llamando a MsiCloseHandle. Para más información, consulte la sección Uso de PMSIHANDLE, en lugar de HANDLE en los procedimientos recomendados de Windows Installer.

Nota

El encabezado msiquery.h define MsiDatabaseGetPrimaryKeys como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Windows Installer 5.0 en Windows Server 2012, Windows 8, Windows Server 2008 R2 o Windows 7. Windows Installer 4.0 o Windows Installer 4.5 en Windows Server 2008 o Windows Vista. Windows Installer en Windows Server 2003 o Windows XP
Plataforma de destino Windows
Encabezado msiquery.h
Library Msi.lib
Archivo DLL Msi.dll

Consulte también

Funciones generales de acceso a base de datos