IContentListSchema::FindColumn Method [C++]
Use this method to find the position of a column specified by name.
Definition
[C++]
HRESULT IContentListSchema::FindColumn(BSTRsName,
long*ColumnNum);
[Visual Basic]
Function FindColumn(sName As String) As Long
Parameters
- sName[C++]
[in] A BSTR that contains the name of the column for which the position will be returned. - sName[Visual Basic]
A String that contains the name of the column for which the position will be returned. - ColumnNum[C++]
[out,retval] A pointer to a long used to return the position of the specified column.
Return Values
[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
[Visual Basic] If this method completes successfully, it returns a Long that contains the position of the new column.
Error Values
[C++] This method returns 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 method 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
Column positions are counted from zero (0), not one (1).
[Visual Basic]
Example
'"Color" is the column name.
Dim iColumnNum as Long
iColumnNum = myContentListSchema.FindColumn("Color")
See Also
[Visual Basic]ContentListSchema Object
Copyright © 2005 Microsoft Corporation.
All rights reserved.