DesignerDocDataService.GetFileDocData Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
GetFileDocData(String, FileAccess, String, Boolean) |
Gets a DocData with the given name. |
GetFileDocData(String, FileAccess, String) |
Gets a DocData with the given name. |
GetFileDocData(String, FileAccess, String, Boolean)
Gets a DocData with the given name.
public:
Microsoft::VisualStudio::Shell::Design::Serialization::DocData ^ GetFileDocData(System::String ^ fileName, System::IO::FileAccess access, System::String ^ createTemplate, bool addToHostList);
public Microsoft.VisualStudio.Shell.Design.Serialization.DocData GetFileDocData (string fileName, System.IO.FileAccess access, string createTemplate, bool addToHostList);
member this.GetFileDocData : string * System.IO.FileAccess * string * bool -> Microsoft.VisualStudio.Shell.Design.Serialization.DocData
Public Function GetFileDocData (fileName As String, access As FileAccess, createTemplate As String, addToHostList As Boolean) As DocData
Parameters
- fileName
- String
The name of the requested child document.
- access
- FileAccess
A FileAccess value that describes the access level of the file.
- createTemplate
- String
The path of a template file to be used in case the named document cannot be retrieved.
- addToHostList
- Boolean
true
to add to the host list, otherwise false
.
Returns
DocData, or null
if the file does not exist and createTemplate
is null
.
Applies to
GetFileDocData(String, FileAccess, String)
Gets a DocData with the given name.
public:
Microsoft::VisualStudio::Shell::Design::Serialization::DocData ^ GetFileDocData(System::String ^ fileName, System::IO::FileAccess access, System::String ^ createTemplate);
public Microsoft.VisualStudio.Shell.Design.Serialization.DocData GetFileDocData (string fileName, System.IO.FileAccess access, string createTemplate);
member this.GetFileDocData : string * System.IO.FileAccess * string -> Microsoft.VisualStudio.Shell.Design.Serialization.DocData
Public Function GetFileDocData (fileName As String, access As FileAccess, createTemplate As String) As DocData
Parameters
- fileName
- String
The name of the requested child document.
- access
- FileAccess
A FileAccess value that describes the access level of the file.
- createTemplate
- String
The path of a template file to be used in case the named document cannot be retrieved.
Returns
DocData, or null
if the file does not exist and createTemplate
is null
.