IProductCatalog::RemoveSpecificationSearchClause

Ee797078.c++_off(en-US,CS.10).gifEe797078.vb_on(en-US,CS.10).gif

Use this method to remove the last constraint from a specified specification search.

Definition

HRESULT IProductCatalog::RemoveSpecificationSearchClause(VARIANT*pstrSearchHandle,BSTR*pstrPoppedClause);

Parameters

pstrSearchHandle

[in, out] A VARIANT that contains the specification search handle from which a constraint is to be removed.

pstrPoppedClause

[out, retval] A pointer to a BSTR used to return the removed clause.

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 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 pstrSearchHandle and pstrPoppedClause parameters contain valid data only if the property was accessed successfully.

This method always removes the last constraint that was added to the search using the AddSpecificationSearchClause method. The returned string will be in the same form as the original constraint.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

See Also

ProductCatalog Object


All rights reserved.