MsiViewGetColumnInfo

[This is preliminary documentation and subject to change.]

The MsiViewGetColumnInfo function returns a record containing column names or definitions.

UINT MsiViewGetColumnInfo(
 MSIHANDLE hView,         // view handle
 MSICOLINFO eColumnInfo,  // type of information to return, names
                          // or definitions
 MSIHANDLE *phRecord      // handle for returned record
);

Parameters

hView

Handle to the view from which to obtain column information.

eColumnInfo

Specifies a flag indicating what type of information is needed. This parameter must be one of the following values.

Value	Meaning
MSICOLINFO_NAMES	Column names are returned.
MSICOLINFO_TYPES	Definitions are returned.

phRecord

Pointer to a handle to receive the column information data record.

Return Values

ERROR_INVALID_HANDLE: An invalid or inactive handle was supplied.
ERROR_INVALID_HANDLE_STATE: The view is not in an Active state.
ERROR_INVALID_PARAMETER: An invalid MSICOLINFO column information enumeration value was passed to the function.
ERROR_SUCCESS: The function succeeded, and a handle to a record was returned.

Remarks

The MsiViewGetColumnInfo function uses the following column definition format.

Column descriptor	Definition string
s?	String, variable length (?=1-255)
s0	String, variable length
i2	Short integer
i4	Long integer
v0	Binary Stream
g?	Temporary string (?=0-255)
j?	Temporary integer (?=0,1,2,4)

Each column is described by a string in the corresponding record field. The definition string consists of a single letter representing the data type followed by the width of the column (in characters when applicable, bytes otherwise). A width of zero designates an unbounded width (for example, long text fields and streams). An uppercase letter indicates that NULL values are allowed in the column.

QuickInfo

  Windows NT: Requires version 4.0 or later. Available as a redistributable for Windows NT 4.0.
  Windows: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in msiquery.h.
  Import Library: Use msi.lib.