DocData.GetCurFile Method

Gets the file name of the document.

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 GetCurFile ( _
    <OutAttribute> ByRef fileName As String, _
    <OutAttribute> ByRef formatIndex As UInteger _
) As Integer
public int GetCurFile(
    out string fileName,
    out uint formatIndex
)
public:
virtual int GetCurFile(
    [OutAttribute] String^% fileName, 
    [OutAttribute] unsigned int% formatIndex
) sealed
abstract GetCurFile : 
        fileName:string byref * 
        formatIndex:uint32 byref -> int  
override GetCurFile : 
        fileName:string byref * 
        formatIndex:uint32 byref -> int
public final function GetCurFile(
    fileName : String, 
    formatIndex : uint
) : int

Parameters

  • fileName
    Type: String%

    The file name of the document.

  • formatIndex
    Type: UInt32%

    Not currently implemented.

Return Value

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

Implements

IPersistFileFormat.GetCurFile(String%, UInt32%)

Remarks

This method implements the IPersistFileFormat interface.

.NET Framework Security

See Also

Reference

DocData Class

Microsoft.VisualStudio.Modeling.Shell Namespace