DocData.IsDocDataReadOnly Method

Verifies whether the document is read-only.

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 IsDocDataReadOnly ( _
    <OutAttribute> ByRef isReadOnly As Integer _
) As Integer
public int IsDocDataReadOnly(
    out int isReadOnly
)
public:
virtual int IsDocDataReadOnly(
    [OutAttribute] int% isReadOnly
) sealed
abstract IsDocDataReadOnly : 
        isReadOnly:int byref -> int  
override IsDocDataReadOnly : 
        isReadOnly:int byref -> int
public final function IsDocDataReadOnly(
    isReadOnly : int
) : int

Parameters

  • isReadOnly
    Type: Int32%

    1 if the document is read-only; otherwise, 0.

Return Value

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

Implements

IVsPersistDocData2.IsDocDataReadOnly(Int32%)

Remarks

This method implements the IVsPersistDocData2 interface.

.NET Framework Security

See Also

Reference

DocData Class

Microsoft.VisualStudio.Modeling.Shell Namespace