IEditorOperations.InsertFile(String) IEditorOperations.InsertFile(String) IEditorOperations.InsertFile(String) IEditorOperations.InsertFile(String) IEditorOperations.InsertFile(String) IEditorOperations.InsertFile(String) Method

Definition

Inserts the contents of a file on disk into the text buffer.

public:
 bool InsertFile(System::String ^ filePath);
public:
 bool InsertFile(Platform::String ^ filePath);
bool InsertFile(std::wstring const & filePath);
public bool InsertFile (string filePath);
abstract member InsertFile : string -> bool
Public Function InsertFile (filePath As String) As Boolean
Parameters
filePath
String String String String String String

The path of the file on disk.

Returns

true if the edit succeeded, otherwise false.

Exceptions

filePath is a zero-length string, contains only white space, or contains one or more invalid characters as defined by GetInvalidPathChars().

The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.

filePath specifies a file that is read-only, or this operation is not supported on the current platform, or filePath specifies a directory, or the caller does not have the required permission.

Applies to