Share via

ITextTemplatingEngineHost.LoadIncludeText(String, String, String) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.TextTemplating
Assembly:
Microsoft.VisualStudio.TextTemplating.Interfaces.10.0.dll
Package:
Microsoft.VisualStudio.TextTemplating.Interfaces.10.0 v17.0.32112.339

Acquires the text that corresponds to a request to include a partial text template file.

public:
 bool LoadIncludeText(System::String ^ requestFileName, [Runtime::InteropServices::Out] System::String ^ % content, [Runtime::InteropServices::Out] System::String ^ % location);
public bool LoadIncludeText (string requestFileName, out string content, out string location);
abstract member LoadIncludeText : string * string * string -> bool
Public Function LoadIncludeText (requestFileName As String, ByRef content As String, ByRef location As String) As Boolean

Parameters

requestFileName
String

The name of the partial text template file to acquire.

content
String

A String that contains the acquired text or Empty if the file could not be found.

location
String

A String that contains the location of the acquired text. If the host searches the registry for the location of include files or if the host searches multiple locations by default, the host can return the final path of the include file in this parameter. The host can set the location to Empty if the file could not be found or if the host is not file-system based.

Returns

Boolean

true to indicate that the host was able to acquire the text; otherwise, false.

Applies to