IContentListSchema::get_ColumnName, put_ColumnName Property [C++]

Article
11/12/2009

The ColumnName property is a read/write string that contains the name of the column.

Definition

[C++]

Get method:

HRESULT IContentListSchema::get_ColumnName(VARIANTvColumn,
 BSTR*ColumnName);

Put method:

HRESULT IContentListSchema::put_ColumnName(VARIANTvColumn,
 BSTRColumnName);

[Visual Basic]

Property ColumnName(vColumn As Variant) As String

Parameters

vColumn[C++]
[in] A VARIANT that contains either the column name or the column position in order to identify the column in question. Column positions are counted from zero (0), not one (1).
vColumn[Visual Basic]
A Variant that contains either the column name or the column position in order to identify the column in question. Column positions are counted from zero (0), not one (1).
ColumnName[C++]
[in] When putting the property, a BSTR that contains the new column name.
[out,retval] When getting the property, a pointer to a BSTR used to return the current column name.

[C++]

Return Values

These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.

Error Values

[C++] These methods return S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This property sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

Though using a column name as the value of the vColumn parameter in order to retrieve that same column name may be fruitless, passing a column name does make sense when changing the column name.