DesignerDocDataService::GetFileDocData Method (String^, FileAccess, String^, Boolean)
Gets a DocData with the given name.
Assembly: Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)
public: DocData^ GetFileDocData( String^ fileName, FileAccess access, String^ createTemplate, bool addToHostList )
Parameters
- fileName
-
Type:
System::String^
The name of the requested child document.
- access
-
Type:
System.IO::FileAccess
A FileAccess value that describes the access level of the file.
- createTemplate
-
Type:
System::String^
The path of a template file to be used in case the named document cannot be retrieved.
- addToHostList
-
Type:
System::Boolean
true to add to the host list, otherwise false.
Return Value
Type: Microsoft.VisualStudio.Shell.Design.Serialization::DocData^DocData, or null if the file does not exist and createTemplate is null.
If the file does not exist and createTemplate points to a valid file, the file will be created as a copy of the template. The file will be checked out from source code control if F:System.IO.FileAccess.Write is requested.
The service keeps track of all doc data objects returned and disposes of them automatically when the service itself is disposed. Because of this files are saved as a unit so usually there is no need to dispose this doc data yourself.