Edit

IColumnProvider::GetColumnInfo method (shlobj.h)

  • Article

Requests information about a column.

Syntax

HRESULT GetColumnInfo(
        DWORD        dwIndex,
  [out] SHCOLUMNINFO *psci
);

Parameters

dwIndex

Type: DWORD

The column's zero-based index. It is an arbitrary value that is used to enumerate columns.

[out] psci

Type: SHCOLUMNINFO*

A pointer to an SHCOLUMNINFO structure to hold the column information.

Return value

Type: HRESULT

Returns a COM error value to indicate that the request was unsuccessful or one of the following values.

Return code Description
S_OK
 Request successful.
S_FALSE
 Column index out of range.

Remarks

This method is called to assign an index to the column and to ask for details on what kind of information the column will contain.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shlobj.h
DLL Shell32.dll (version 5.0 or later)

See also

IColumnProvider