IVsFindSymbol2.GetUserOptions Method

Article
2013-03-06

Returns the search options.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.9.0 (in Microsoft.VisualStudio.Shell.Interop.9.0.dll)

Syntax

'Declaration
Function GetUserOptions ( _
    <OutAttribute> ByRef pguidScope As Guid, _
    <OutAttribute> ByRef pdwSubID As UInteger, _
    <OutAttribute> pobSrch As VSOBSEARCHCRITERIA2() _
) As Integer

int GetUserOptions(
    out Guid pguidScope,
    out uint pdwSubID,
    VSOBSEARCHCRITERIA2[] pobSrch
)

int GetUserOptions(
    [OutAttribute] Guid% pguidScope, 
    [OutAttribute] unsigned int% pdwSubID, 
    [OutAttribute] array<VSOBSEARCHCRITERIA2>^ pobSrch
)

abstract GetUserOptions : 
        pguidScope:Guid byref * 
        pdwSubID:uint32 byref * 
        pobSrch:VSOBSEARCHCRITERIA2[] byref -> int

function GetUserOptions(
    pguidScope : Guid, 
    pdwSubID : uint, 
    pobSrch : VSOBSEARCHCRITERIA2[]
) : int

Parameters

pguidScope
Type: System.Guid%
[out] A GUID specifying the search scope.

pdwSubID
Type: System.UInt32%
[out] Scope subID. Must be zero unless guidSymbolScope is GUID_VsSymbolScope_Frameworks.

pobSrch
Type: array<Microsoft.VisualStudio.Shell.Interop.VSOBSEARCHCRITERIA2[]
[out] Bit flags indicating search options. Constructed using values from the _VSOBSEARCHOPTIONS2 enumeration.

Return Value

Type: System.Int32
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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via