Función MsiSummaryInfoGetPropertyA (msiquery.h)
La función
Sintaxis
UINT MsiSummaryInfoGetPropertyA(
[in] MSIHANDLE hSummaryInfo,
[in] UINT uiProperty,
[out] PUINT puiDataType,
[out] LPINT piValue,
[out] FILETIME *pftValue,
[out] LPSTR szValueBuf,
[in, out] LPDWORD pcchValueBuf
);
Parámetros
[in] hSummaryInfo
Controlar la información de resumen.
[in] uiProperty
Especifica el identificador de propiedad de la propiedad summary. Este parámetro puede ser un identificador de propiedad que aparece en conjunto de propiedades de flujo de información de resumen. Esta función no devuelve valores para PID_DICTIONARY propiedad OR PID_THUMBNAIL.
[out] puiDataType
Recibe el tipo de propiedad devuelto. Este parámetro puede ser un tipo que aparece en el
propiedad Flujo de información de resumen establecida.
[out] piValue
Recibe los datos de propiedad entero devueltos.
[out] pftValue
Puntero a un valor de archivo.
[out] szValueBuf
Puntero al búfer que recibe el valor de la propiedad de la propiedad de información de resumen terminada en NULL. No intente determinar el tamaño del búfer pasando un valor NULL (value=0) para szValueBuf. Puede obtener el tamaño del búfer pasando una cadena vacía (por ejemplo, ""). A continuación, la función devuelve ERROR_MORE_DATA y pcchValueBuf contiene el tamaño de búfer necesario en TCHAR, sin incluir el carácter nulo de terminación. Al devolver ERROR_SUCCESS, pcchValueBuf contiene el número de TCHAR escritos en el búfer, no incluido el carácter nulo de terminación. Este parámetro es una cadena vacía si no hay errores.
[in, out] pcchValueBuf
Puntero a la variable que especifica el tamaño, en TCHAR, del búfer al que apunta la variable szValueBuf. Cuando la función devuelve ERROR_SUCCESS, esta variable contiene el tamaño de los datos copiados en szValueBuf, sin incluir el carácter nulo de terminación. Si szValueBuf no es lo suficientemente grande, la función devuelve ERROR_MORE_DATA y almacena el tamaño necesario, no incluido el carácter nulo de terminación, en la variable a la que apunta pcchValueBuf.
Valor devuelto
La función
Observaciones
Si se devuelve ERROR_MORE_DATA, el parámetro que es un puntero proporciona el tamaño del búfer necesario para contener la cadena. Si se devuelve ERROR_SUCCESS, proporciona el número de caracteres escritos en el búfer de cadenas. Por lo tanto, puede obtener el tamaño del búfer pasando una cadena vacía (por ejemplo, "") para el parámetro que especifica el búfer. No intente determinar el tamaño del búfer pasando un valor Null (valor=0).
Las funciones de Windows Installer que devuelven datos en una ubicación de memoria proporcionada por el usuario no deben llamarse con null como valor para el puntero. Estas funciones devuelven una cadena o devuelven datos como punteros enteros, pero devuelven valores incoherentes al pasar null como valor para el argumento de salida. Para obtener más información, vea pasar null como argumento de funciones de Windows Installer.
La información de propiedad devuelta por la función
Nota
El encabezado msiquery.h define MsiSummaryInfoGetProperty 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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.
Requisitos
| Requisito | Valor |
|---|---|
| cliente mínimo admitido | 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 |
| de la plataforma de destino de |
Windows |
| encabezado de |
msiquery.h |
| biblioteca de |
Msi.lib |
| DLL de |
Msi.dll |
Consulte también
pasar null como argumento de funciones de Windows Installer
funciones de propiedades de información de resumen