Share via


IVsSccProjectProviderBinding.ValidateServerPathEdit Method

Definition

Determines if the given source control server path is valid.

public:
 int ValidateServerPathEdit(int fQuick, System::String ^ lpszServerPath, [Runtime::InteropServices::Out] int % pfValidServer);
int ValidateServerPathEdit(int fQuick, std::wstring const & lpszServerPath, [Runtime::InteropServices::Out] int & pfValidServer);
public int ValidateServerPathEdit (int fQuick, string lpszServerPath, out int pfValidServer);
abstract member ValidateServerPathEdit : int * string * int -> int
Public Function ValidateServerPathEdit (fQuick As Integer, lpszServerPath As String, ByRef pfValidServer As Integer) As Integer

Parameters

fQuick
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
String

[in] The server path to be validated.

pfValidServer
Int32

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

Returns

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

Remarks

COM Signature

From ivssccprojectproviderbinding.idl

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.

Applies to