IVsToolboxDataProvider::FileDropped Method (String^, IVsHierarchy^, Int32)

Visual Studio 2015

Sends notification that a file is being dropped on the Toolbox.

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

Syntax

C++

int FileDropped(
	String^ pszFilename,
	IVsHierarchy^ pHierSource,
	[OutAttribute] int% pfFileProcessed
)

Parameters

pszFilename: Type: System::String^
[in] Name of file dropped.

pHierSource: Type: Microsoft.VisualStudio.Shell.Interop::IVsHierarchy^
[in] Source hierarchy containing the dropped file. This value may be null if the file is not associated with a hierarchy.

pfFileProcessed: Type: System::Int32
[out, retval] If true, then the file was successfully processed. If false, then the file was not processed.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IVsToolboxDataProvider::FileDropped(
   [in]LPCOLESTR pszFileName,
   [in]IVsHierarchy *pHierSource,
   [out,retval]BOOL *pfFileProcessed
);

When your data provider receives notification of a file being dropped on the Toolbox, you can then process the file and add items to the Toolbox. If you successfully process the file, then return a value of true for the pfFileProcessed parameter, or false if you do not process the file.