Partager via

DesignerDocDataService.GetFileDocData Method (String, FileAccess, String, Boolean)

  • Article

Gets a DocData with the given name.

Namespace:  Microsoft.VisualStudio.Shell.Design.Serialization
Assembly:  Microsoft.VisualStudio.Shell.Design (in Microsoft.VisualStudio.Shell.Design.dll)

Syntax

'Declaration
Public Function GetFileDocData ( _
    fileName As String, _
    access As FileAccess, _
    createTemplate As String, _
    addToHostList As Boolean _
) As DocData

public DocData GetFileDocData(
    string fileName,
    FileAccess access,
    string createTemplate,
    bool addToHostList
)

public:
DocData^ GetFileDocData(
    String^ fileName, 
    FileAccess access, 
    String^ createTemplate, 
    bool addToHostList
)

member GetFileDocData : 
        fileName:string * 
        access:FileAccess * 
        createTemplate:string * 
        addToHostList:bool -> DocData

public function GetFileDocData(
    fileName : String, 
    access : FileAccess, 
    createTemplate : String, 
    addToHostList : boolean
) : DocData

Parameters

  • fileName
    Type: String

    The name of the requested child document.

  • access
    Type: FileAccess

    A FileAccess value that describes the access level of the file.

  • createTemplate
    Type: String

    The path of a template file to be used in case the named document cannot be retrieved.

  • addToHostList
    Type: Boolean

    true to add to the host list, otherwise false.

Return Value

Type: Microsoft.VisualStudio.Shell.Design.Serialization.DocData
DocData , or nulla null reference (Nothing in Visual Basic) if the file does not exist and createTemplate is nulla null reference (Nothing in Visual Basic).

Remarks

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.

.NET Framework Security

See Also

Reference

DesignerDocDataService Class

GetFileDocData Overload

Microsoft.VisualStudio.Shell.Design.Serialization Namespace