IVsSolution.GetProjrefOfItem Method

Returns a project reference string for the specified hierarchy and hierarchy item pair.

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

Syntax

'Declaration
Function GetProjrefOfItem ( _
    pHierarchy As IVsHierarchy, _
    itemid As UInteger, _
    <OutAttribute> ByRef pbstrProjref As String _
) As Integer
'Usage
Dim instance As IVsSolution
Dim pHierarchy As IVsHierarchy
Dim itemid As UInteger
Dim pbstrProjref As String
Dim returnValue As Integer

returnValue = instance.GetProjrefOfItem(pHierarchy, _
    itemid, pbstrProjref)

int GetProjrefOfItem(
    IVsHierarchy pHierarchy,
    uint itemid,
    out string pbstrProjref
)

int GetProjrefOfItem(
    [InAttribute] IVsHierarchy^ pHierarchy, 
    [InAttribute] unsigned int itemid, 
    [OutAttribute] String^% pbstrProjref
)

abstract GetProjrefOfItem : 
        pHierarchy:IVsHierarchy * 
        itemid:uint32 * 
        pbstrProjref:string byref -> int

function GetProjrefOfItem(
    pHierarchy : IVsHierarchy, 
    itemid : uint, 
    pbstrProjref : String
) : int

Parameters

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

itemid
Type: System.UInt32
[in] Valid item identifier within the project; not a VSITEMID value.

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:

HRESULT IVsSolution::GetProjrefOfItem(
   [in] IVsHierarchy *pHierarchy,
   [in] VSITEMID itemid,
   [out] BSTR *pbstrProjref
);

The following is a description of how the GetProjrefOfItem 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.

.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.