IHeaderCtrl::GetColumnText

[This is preliminary documentation and subject to change.]

Retrieves text from a specified column.

HRESULT GetColumnText(
  int nCol,         // Zero-based index of the column
  LPOLESTR * pText  // Pointer to the text
);
 

Parameters

nCol

[in] Zero-based index that identifies the column from which the text is to be retrieved.

pText

[out] Pointer to the address of the text to be retrieved. This pointer must not be NULL. The user is responsible for calling CoTaskMemFree on the returned text. This function is documented in the Platform SDK.

E_POINTER

The pText parameter is NULL.

Return 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 be sure to free the memory using CoTaskMemFree.