_SimpleFindSearchInfo::get_StatusFilter, put_StatusFilter
.gif "Ee784285.c++_off(en-US,CS.10).gif")
.gif "Ee784285.vb_on(en-US,CS.10).gif")
The StatusFilter property is a read/write Variant that contains the OrderGroup status.
Definition
Get method:
HRESULT _SimpleFindSearchInfo::get_StatusFilter(long*StatusFilter);
Put method:
HRESULT _SimpleFindSearchInfo::put_StatusFilter(longStatusFilter);
Parameters
StatusFilter
[in] When putting the property, a long that contains the OrderGroup status.
[out, retval] When getting the property, a long used to return the OrderGroup status.
Return Values
These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.
Error Values
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.
Remarks
The StatusFilter parameter contains valid data only if the property is accessed successfully.
The value of the StatusFilter parameter determines whether a search is being made for a basket, an order, a template, or a combination of these. A bit field is used to determine this. The following table shows the meaning of the individual bits.
| Status Type | Value |
| Basket | 1 |
| Template | 2 |
| New Order | 4 |
| Custom | 8 |
| Custom | 16 |
.gif "Ee784285.note(en-US,CS.10).gif")
Note
Because the contents of baskets and templates are held in one table, and the contents of OrderGroups with all other status codes (codes 4 and greater) are held elsewhere, only certain values are permissible for searches.
The following values are permissible:
1 (basket search)
2 (template search)
3 (basket or template)
4 (new order)
12 ( 4 & 8)
24 (8 & 16)
The following values are not permissible:
5 (basket or new order)
6 (template or new order)
9 (1 & 8)
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.