IVsMSBuildTaskFileManager.GetFileDocData Method

Article
2013-03-06

Gets the DocData object for a file registered in the RDT.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.9.0 (in Microsoft.VisualStudio.Shell.Interop.9.0.dll)

Syntax

'Declaration
Function GetFileDocData ( _
    wszFilename As String, _
    <OutAttribute> ByRef ppunkDocData As IntPtr _
) As Integer

int GetFileDocData(
    string wszFilename,
    out IntPtr ppunkDocData
)

int GetFileDocData(
    [InAttribute] String^ wszFilename, 
    [OutAttribute] IntPtr% ppunkDocData
)

abstract GetFileDocData : 
        wszFilename:string * 
        ppunkDocData:IntPtr byref -> int

function GetFileDocData(
    wszFilename : String, 
    ppunkDocData : IntPtr
) : int

Parameters

wszFilename
Type: System.String
[in] The name of the file.

ppunkDocData
Type: System.IntPtr%
[out] A pointer to the DocData object interface.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code. If the specified file is not registered in the RDT, it returns NULL.

Remarks

COM Signature

From vsshell90.idl:

HRESULT GetFileDocData(
    [in] LPCOLESTR wszFilename,
    [out, retval] IUnknown** ppunkDocData
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via