CodeQL library for C#
codeql/csharp-all 3.1.1-dev (changelog, source)
Search

Class LocalScopeVariable

A locally scoped variable. Either a local variable (LocalVariable) or a parameter (Parameter).

Import path

import csharp

Direct supertypes

Indirect supertypes

Known direct subtypes

Predicates

getACapturingCallable

Gets a callable that captures this variable, if any. For example, v is captured by the nested lambda expression in

getCallable

Gets the callable in which this variable is defined.

isCaptured

Holds if this variable is captured by a nested callable. For example, v is captured by the nested lambda expression in

isRef

Holds if this local variable or parameter is a ref.

isScoped

Holds if this local variable or parameter is scoped.

Inherited predicates

fromLibrary

Holds if this element is from an assembly.

from Element
fromSource

Holds if this element is from source code.

from Element
getAChild

Gets a child of this element, if any.

from Element
getALocation

Gets a location of this element, including sources and assemblies.

from Element
getAPrimaryQlClass

Gets the name of a primary CodeQL class to which this element belongs.

from Element
getAnAccess

Gets an access to this assignable.

from Variable
getAnAssignedValue

Gets an expression assigned to this assignable, if any.

from Assignable
getAnnotatedType

Gets the annotated type of this assignable.

from Assignable
getChild

Gets the ith child of this element (zero-based).

from Element
getDeclaringType

Gets the type containing this declaration, if any.

from Declaration
getFile

Gets the file containing this element.

from Element
getFullyQualifiedName

DEPRECATED: Use hasFullyQualifiedName instead.

from NamedElement
getFullyQualifiedNameDebug

INTERNAL: Do not use.

from NamedElement
getFullyQualifiedNameWithTypes

Gets the fully qualified name of this declaration, including types, for example the fully qualified name with types of M on line 3 is N.C.M(int, string) in

from Declaration
getIndex

Gets the index of this element among its parent’s other children (zero-based).

from Element
getInitializer

Gets the expression used to initialise this variable, if any.

from Variable
getLocation

Gets the location of this element. Where an element has locations in source and assemblies, choose the source location. If there are multiple assembly locations, choose only one.

from Element
getName

Gets the name of this element.

from NamedElement
getNumberOfChildren

Gets the number of children of this element.

from Element
getParent

Gets the parent of this element, if any.

from Element
getPrimaryQlClasses

Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.

from Element
getType

Gets the type of this variable.

from Variable
getUnboundDeclaration

Gets the unbound version of this declaration, that is, the declaration where all type arguments have been removed. For example, in

from Variable
getUndecoratedName

Gets the name of this declaration, without additional decoration such as <...>.

from Declaration
hasFullyQualifiedName

Holds if this element has the fully qualified name qualifier.name.

from Declaration
hasName

Holds if this element has name ‘name’.

from NamedElement
hasUndecoratedName

Holds if this element has undecorated name ‘name’.

from Declaration
isCompilerGenerated

Holds if this declaration has been generated by the compiler, for example implicit constructors or accessors.

from Declaration
isSourceDeclaration

Holds if this declaration is unconstructed and in source code.

from Declaration
isUnboundDeclaration

Holds if this declaration is unbound.

from Declaration
toString

Gets a textual representation of this element.

from Declaration
toStringWithTypes

Gets the full textual representation of this element, including type information.

from Element