IVsFindSymbol2.GetUserOptions(Guid, UInt32, VSOBSEARCHCRITERIA2[]) Method

Definition

Returns the search options.

public:
 int GetUserOptions([Runtime::InteropServices::Out] Guid % pguidScope, [Runtime::InteropServices::Out] System::UInt32 % pdwSubID, cli::array <Microsoft::VisualStudio::Shell::Interop::VSOBSEARCHCRITERIA2> ^ pobSrch);
public int GetUserOptions (out Guid pguidScope, out uint pdwSubID, Microsoft.VisualStudio.Shell.Interop.VSOBSEARCHCRITERIA2[] pobSrch);
abstract member GetUserOptions : Guid * uint32 * Microsoft.VisualStudio.Shell.Interop.VSOBSEARCHCRITERIA2[] -> int
Public Function GetUserOptions (ByRef pguidScope As Guid, ByRef pdwSubID As UInteger, pobSrch As VSOBSEARCHCRITERIA2()) As Integer

Parameters

pguidScope
Guid

[out] A GUID specifying the search scope.

pdwSubID
UInt32

[out] Scope subID. Must be zero unless guidSymbolScope is GUID_VsSymbolScope_Frameworks.

pobSrch
VSOBSEARCHCRITERIA2[]

[out] Bit flags indicating search options. Constructed using values from the _VSOBSEARCHOPTIONS2 enumeration.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell90.idl:

HRESULT GetUserOptions(  
    [out] GUID * pguidScope,   
    [out] DWORD dwSubID,   
    [out] VSOBSEARCHCRITERIA2 *pobSrch  
);  

Notes to Callers

There are five GUIDs for specifying the search scope defined in vsshell80.idl:

GUID Name Description
GUID_VsSymbolScope_All Search all scopes for the symbol.
GUID_VsSymbolScope_OBSelectedComponents Search items selected in the Object Browser for the symbol.
GUID_VsSymbolScope_FSSelectedComponents Search items selected in the file system.
GUID_VsSymbolScope_Frameworks Search all frameworks for the symbol.
GUID_VsSymbolScope_Solution Search the solution for the symbol.

Applies to