IListManager::SetListProperty
.gif "Ee811368.c++_off(en-US,CS.10).gif")
.gif "Ee811368.vb_on(en-US,CS.10).gif")
Use this method to set a property of a list.
Definition
HRESULT IListManager::SetListProperty(VARIANTlistID,BSTRlistPropertyName,VARIANTListProp);
Parameters
listID
[in] A VARIANT that contains the ID or name of the list.
listPropertyName
[in] A BSTR that contains the property name (column of the lm_master table).
ListProp
[in] A VARIANT that contains the value to set the property.
Return Values
This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
Error Values
This method returns S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.
The following table shows the custom COM errors that this method can return.
| Constant | Value | Description |
| E_LM_LIST_BUSY | 0x8C400008 | The specified list is currently busy with another operation. |
| E_LM_LIST_IN_FAILED_STATE | 0x8C40001D | The specified list is in a FAILED state and may not be used for the operation. |
| E_LM_LIST_MUST_BE_DYNAMIC | 0x8C400012 | The operation requires a dynamic list and the specified list is not a dynamic list. |
| E_LM_LIST_NOT_FOUND | 0x8C400006 | The specified list does not exist. |
| E_LM_LISTPROP_NOT_UPDATEABLE | 0x8C400013 | The specified list property cannot be changed after the list has been created. |
| E_LM_SQLERROR | 0x8C400003 | Error while executing SQL/ADO operation. |
| OLE_E_BLANK | 0x80040007 | The ListManager object has not been properly initialized. |
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.
Remarks
This method is usually used to change properties of a dynamic list, such as the table name, connection string, or SQL query from which a dynamic list is created.
The following properties may be set by this method:
list_name
list_description
list_userflags
list_err_limit (dynamic lists only)
list_query (dynamic lists only)
list_source (dynamic lists only)
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.