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

Class AssignableDefinitions::OutRefDefinition

A definition via an out/ref argument in a call, for example M(out x, ref y).

Import path

import csharp

Direct supertypes

Indirect supertypes

Fields

Predicates

getCall

Gets the underlying call.

getIndex

Gets the index of this definition among the other definitions in the out/ref assignment. For example, in M(out x, ref y) the index of the definitions of x and y are 0 and 1, respectively.

getLocation

Gets the location of this assignable definition.

isCertain

Holds if this definition is guaranteed to update the targeted assignable. The only potentially uncertain definitions are ref assignments.

toString

Gets a textual representation of this assignable definition.

Inherited predicates

getAControlFlowNode

DEPRECATED: Use this.getExpr().getAControlFlowNode() instead.

from AssignableDefinition
getAFirstRead

Gets a first read of the same underlying assignable. That is, a read that can be reached from this definition without passing through any other reads, and which is guaranteed to read the value assigned in this definition. Example:

from AssignableDefinition
getElement

Gets the underlying element associated with this definition. This is either an expression or a parameter.

from AssignableDefinition
getEnclosingCallable

Gets the enclosing callable of this definition.

from AssignableDefinition
getExpr

Gets the underlying expression that updates the targeted assignable when reached, if any.

from AssignableDefinition
getSource

Gets the assigned expression, if any. For example, the expression assigned in x = 0 is 0. The value may not always exists, for example in assignments via out/ref parameters.

from AssignableDefinition
getTarget

Gets the assignable being defined.

from AssignableDefinition
getTargetAccess

Gets the access used in the definition of the underlying assignable, if any. Local variable declarations and implicit parameter definitions are the only definitions without associated accesses.

from AssignableDefinition

Charpred