DocData.Load Method (String, UInt32, Int32)

Loads the document into memory.

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Syntax

'Declaration
Public Function Load ( _
    fileName As String, _
    mode As UInteger, _
    isReadOnly As Integer _
) As Integer
public int Load(
    string fileName,
    uint mode,
    int isReadOnly
)
public:
virtual int Load(
    String^ fileName, 
    unsigned int mode, 
    int isReadOnly
) sealed
abstract Load : 
        fileName:string * 
        mode:uint32 * 
        isReadOnly:int -> int  
override Load : 
        fileName:string * 
        mode:uint32 * 
        isReadOnly:int -> int
public final function Load(
    fileName : String, 
    mode : uint, 
    isReadOnly : int
) : int

Parameters

  • fileName
    Type: String

    The file name of the document.

  • mode
    Type: UInt32

    Not currently implemented.

  • isReadOnly
    Type: Int32

    Not currently implemented.

Return Value

Type: Int32
S_OK if the method succeeds; otherwise, it returns an error code.

Implements

IPersistFileFormat.Load(String, UInt32, Int32)

Remarks

This method implements the IVsPersistDocData2 interface.

.NET Framework Security

See Also

Reference

DocData Class

Load Overload

Microsoft.VisualStudio.Modeling.Shell Namespace