Interface MultiDocumentHighlightProvider

provideMultiDocumentHighlights

• provideMultiDocumentHighlights(
      document: TextDocument,
      position: Position,
      otherDocuments: TextDocument[],
      token: CancellationToken,
  ): ProviderResult<MultiDocumentHighlight[]>

  Provide a set of document highlights, like all occurrences of a variable or all exit-points of a function.

  Parameters

  • document: TextDocument

    The document in which the command was invoked.

  • position: Position

    The position at which the command was invoked.

  • otherDocuments: TextDocument[]

    An array of additional valid documents for which highlights should be provided.

  • token: CancellationToken

    A cancellation token.

  Returns ProviderResult<MultiDocumentHighlight[]>

  A Map containing a mapping of the Uri of a document to the document highlights or a thenable that resolves to such. The lack of a result can be signaled by returning undefined, null, or an empty map.