IVsSolution::GetProjrefOfProject Method (IVsHierarchy^, String^)

Visual Studio 2015

Returns a project reference string for the specified hierarchy.

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

Syntax

C++

int GetProjrefOfProject(
	IVsHierarchy^ pHierarchy,
	[OutAttribute] String^% pbstrProjref
)

Parameters

pHierarchy: Type: Microsoft.VisualStudio.Shell.Interop::IVsHierarchy^
[in] Pointer to the IVsHierarchy interface for the specified hierarchy.

pbstrProjref: Type: System::String^
[out] Pointer to the project reference string.

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 IVsSolution::GetProjrefOfProject(
   [in] IVsHierarchy *pHierarchy,
   [out] BSTR *pbstrProjref
);

The following is a description of how the GetProjrefOfProject method is used to support drag-and-drop operations:

The CF_VSPROJECTITEMS and CF_VSPROJECTS clipboard formats use the DROPFILES structure in the same manner as CF_HDROP or CF_PRINTERS. The data that follows the DROPFILES structure is a double-NULL-terminated list of Projref strings. The consumer of the drop operation can use the Windows API DragQueryFile to examine the data in the DROPFILES structure. CF_VSPROJECTS format is offered when the Projref strings identify projects as a whole, that is, *pitemid == VSITEMID_ROOT. The CF_VSPROJECTITEMS format is offered when the Projref strings identify one or more individual project items. Either CF_VSPROJECTS or CF_VSPROJECTITEMS should be offered, but never both.