CWBSO_DisallowListFilter

Use the CWBSO_DisallowListFilter API with this product.

Purpose

Sets the list to disallow the user from changing the filter values for the list. This disables the INCLUDE choice from the VIEW pull-down menu when the list is displayed. The list is displayed by calling CWBSO_DisplayList. This API is only meaningful for lists which are displayed by using the CWBSO_DisplayList API. This API can only be called once for a list, and it must be called prior to displaying the list.

Syntax

 
unsigned int CWB_ENTRY CWBSO_DisallowListFilter(
                CWBSO_LIST_HANDLE listHandle);

Parameters

CWBSO_LIST_HANDLE listHandle - input: A handle to a list that is returned by a previous call to CWBSO_CreateListHandle or CWBSO_CreateListHandleEx.

Return Codes

The following list shows common return values.

CWBSO_NO_ERROR: No error occurred.
CWBSO_BAD_LIST_HANDLE: The list handle that is specified is not valid.

Usage

CWBSO_CreateListHandle must be called prior to calling this API. The list handle that is returned by CWBSO_CreateListHandle must be passed as input to this API.