IVsSccProjectProviderBinding::ValidateServerPathEdit Method (Int32, String^, Int32)

Visual Studio 2015

Determines if the given source control server path is valid.

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

Syntax

C++

int ValidateServerPathEdit(
	int fQuick,
	String^ lpszServerPath,
	[OutAttribute] int% pfValidServer
)

Parameters

fQuick: Type: System::Int32
[in] Nonzero (true) if the validation should be fast (this allows the validation to be used during editing and does not slow it down for things like network access).

lpszServerPath: Type: System::String^
[in] The server path to be validated.

pfValidServer: Type: System::Int32
[out] Returns nonzero (true) if the path is valid; otherwise, returns zero (false).

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

C++

HRESULT ValidateServerPathEdit(
   [in] BOOL fQuick,
   [in] LPCOLESTR lpszServerPath,
   [out, retval] BOOL * pfValidServer
);

This method can be called on the fly while the user is actively editing the enlistment choice (in an edit field). In this case, fQuick is set to nonzero so that the editing process is not adversely affected. If fQuick is zero, then this method can do whatever it needs to be sure the server path is valid.