Share via


IHeaderCtrl2::GetColumnText method

The IHeaderCtrl2::GetColumnText method retrieves text from a specified column.

Syntax

HRESULT GetColumnText(
  [in]  int      nCol,
  [out] LPOLESTR *pText
);

Parameters

  • nCol [in]
    A zero-based index that identifies the column from which the text is to be retrieved.

  • pText [out]
    A pointer to the address of the text to be retrieved. This pointer must not be NULL. The user must call CoTaskMemFree on the returned text.

Return value

This method can return one of these values.

  • S_OK
    The column text was successfully retrieved.

  • E_UNEXPECTED
    The current result view is not the console-provided default view.

  • E_INVALIDARG
    The nCol parameter is not a valid column index.

  • E_POINTER
    The pText parameter is NULL.

Remarks

GetColumnText allocates the string for the result and stores its pointer at the location specified by pText. The caller must free the memory using CoTaskMemFree.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Mmc.h

DLL

Mmcndmgr.dll

See also

IHeaderCtrl2