IVsProject2::IsDocumentInProject Method (String^, Int32, array<VSDOCUMENTPRIORITY>^, UInt32)

Visual Studio 2015

Determines whether a document is in the project.

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

Syntax

C++

int IsDocumentInProject(
	String^ pszMkDocument,
	[OutAttribute] int% pfFound,
	array<VSDOCUMENTPRIORITY>^ pdwPriority,
	[OutAttribute] unsigned int% pitemid
)

Parameters

pszMkDocument: Type: System::String^
[in] Pointer to the document moniker for which to search.

pfFound: Type: System::Int32
[out] Pointer to a BOOL. Implementer sets contents to true if the document is found in the project, false if otherwise or an error occurs.

pdwPriority: Type: array<Microsoft.VisualStudio.Shell.Interop::VSDOCUMENTPRIORITY>^
[out] Priority level whose value is taken from the VSDOCUMENTPRIORITY enumeration if the document is found; zero if not or an error occurs.

pitemid: Type: System::UInt32
[out] Pointer to the item identifier of the document within the project. Should be VSITEMID_ROOT or other valid item identifier. See the enumeration VSITEMID. If the document is found, implementer sets contents to a value; if not found or an error occurs, implementer sets contents to zero.

Return Value

Type: System::Int32

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

Implements

IVsProject::IsDocumentInProject(String^, Int32, array<VSDOCUMENTPRIORITY>^, UInt32)

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IVsProject2::IsDocumentInProject(
   [in] LPCOLESTR pszMkDocument,
   [out] BOOL *pfFound,
   [out] VSDOCUMENTPRIORITY *pdwPriority,
   [out] VSITEMID *pitemid
);

If any parameter is null, set any non-null parameter to its error setting, and return E_INVALIDARG.