IVsObjectList.CanGoToSource Method
Returns a flag indicating if navigation to the given list item's source is supported.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Function CanGoToSource ( _
index As UInteger, _
SrcType As VSOBJGOTOSRCTYPE, _
<OutAttribute> ByRef pfOK As Integer _
) As Integer
int CanGoToSource(
uint index,
VSOBJGOTOSRCTYPE SrcType,
out int pfOK
)
int CanGoToSource(
[InAttribute] unsigned int index,
[InAttribute] VSOBJGOTOSRCTYPE SrcType,
[OutAttribute] int% pfOK
)
abstract CanGoToSource :
index:uint32 *
SrcType:VSOBJGOTOSRCTYPE *
pfOK:int byref -> int
function CanGoToSource(
index : uint,
SrcType : VSOBJGOTOSRCTYPE,
pfOK : int
) : int
Parameters
- index
Type: System.UInt32
[in] Specifies the index of the list item of interest.
- SrcType
Type: Microsoft.VisualStudio.Shell.Interop.VSOBJGOTOSRCTYPE
[in] Specifies the source type. Values are taken from the VSOBJGOTOSRCTYPE enumeration.
- pfOK
Type: System.Int32%
[out] Pointer to a flag indicating whether navigation is supported.
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 vsshell.idl:
HRESULT IVsObjectList::CanGoToSource(
[in] ULONG Index,
[in] VSOBJGOTOSRCTYPE SrcType,
[out] BOOL *pfOK
);
Return true in pfOK if navigation to the source of the specified type (definition, declaration, or reference), is possible, false otherwise. This is what enables the GoToDefinition, GoToDeclaration, and GoToReference commands in the UI. Most languages do not have a separate declaration from the definition.
.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.