Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 3.18 KB

nf-shobjidl-isearchboxinfo-getcondition.md

File metadata and controls

83 lines (64 loc) · 3.18 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:shobjidl.ISearchBoxInfo.GetCondition
ISearchBoxInfo::GetCondition (shobjidl.h)
Retrieves the contents of the search box as an ICondition object.
GetCondition
GetCondition method [Windows Shell]
GetCondition method [Windows Shell]
ISearchBoxInfo interface
ISearchBoxInfo interface [Windows Shell]
GetCondition method
ISearchBoxInfo.GetCondition
ISearchBoxInfo::GetCondition
_shell_ISearchBoxInfo_GetCondition
shell.ISearchBoxInfo_GetCondition
shobjidl/ISearchBoxInfo::GetCondition
shell\ISearchBoxInfo_GetCondition.htm
shell
9a1159df-78ef-493b-8286-eefb0ac004ef
12/05/2018
GetCondition, GetCondition method [Windows Shell], GetCondition method [Windows Shell],ISearchBoxInfo interface, ISearchBoxInfo interface [Windows Shell],GetCondition method, ISearchBoxInfo.GetCondition, ISearchBoxInfo::GetCondition, _shell_ISearchBoxInfo_GetCondition, shell.ISearchBoxInfo_GetCondition, shobjidl/ISearchBoxInfo::GetCondition
shobjidl.h
Windows
Windows 7 [desktop apps only]
Windows Server 2008 R2 [desktop apps only]
Shobjidl.idl
Windows
19H1
ISearchBoxInfo::GetCondition
shobjidl/ISearchBoxInfo::GetCondition
c++
APIRef
kbSyntax
COM
Shobjidl.h
ISearchBoxInfo.GetCondition

ISearchBoxInfo::GetCondition

-description

Retrieves the contents of the search box as an ICondition object.

-parameters

-param riid [in]

Type: REFIID

A reference to the IID of the interface to retrieve through ppv, typically IID_ICondition.

-param ppv [out]

Type: void**

When this method returns successfully, contains the interface pointer requested in riid. This is typically ICondition.

-returns

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

-remarks

As opposed to the text string retrieved by ISearchBoxInfo::GetText, GetCondition retrieves the same information as a structured object, the methods of which can be used to parse and manipulate the search string.

We recommend that you use the IID_PPV_ARGS macro, defined in Objbase.h, to package the riid and ppv parameters. This macro provides the correct IID based on the interface pointed to by the value in ppv, which eliminates the possibility of a coding error in riid that could lead to unexpected results.

-see-also

ISearchBoxInfo