DocData.SetDocDataReadOnly Method

Sets the document's read-only flag.

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

Syntax

'Declaration
Public Function SetDocDataReadOnly ( _
    newValue As Integer _
) As Integer
'Usage
Dim instance As DocData 
Dim newValue As Integer 
Dim returnValue As Integer 

returnValue = instance.SetDocDataReadOnly(newValue)
public int SetDocDataReadOnly(
    int newValue
)
public:
virtual int SetDocDataReadOnly(
    int newValue
) sealed
public final function SetDocDataReadOnly(
    newValue : int
) : int

Parameters

  • newValue
    Type: System.Int32

    1 if the document is read-only; otherwise, 0. By default, this value is 1.

Return Value

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

Implements

IVsPersistDocData2.SetDocDataReadOnly(Int32)

Remarks

This method implements the IVsPersistDocData2 interface.

.NET Framework Security

See Also

Reference

DocData Class

DocData Members

Microsoft.VisualStudio.Modeling.Shell Namespace