IVsProjectServerHost.StartServer Method

Creates a process for a hosted server.

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

Syntax

'Declaration
Function StartServer ( _
    bstrEnvironment As String, _
    <OutAttribute> ByRef pdwProcessId As UInteger _
) As Integer

int StartServer(
    string bstrEnvironment,
    out uint pdwProcessId
)

int StartServer(
    [InAttribute] String^ bstrEnvironment, 
    [OutAttribute] unsigned int% pdwProcessId
)

abstract StartServer : 
        bstrEnvironment:string * 
        pdwProcessId:uint32 byref -> int

function StartServer(
    bstrEnvironment : String, 
    pdwProcessId : uint
) : int

Parameters

bstrEnvironment
Type: System.String

Environment in which to start the server. If not specified, the default environment is used.

pdwProcessId
Type: System.UInt32%

The ID of the new process.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

If the server is already running then this method has no effect.

The bstrEnvironment parameter contains a list of NULL-terminated strings terminated by a double NULL {\0\0}. Appropriate methods (such as using SysAllocStringLen Function) must be used when copying this BSTR.

COM Signature

From vsshell90.idl:

HRESULT StartServer(
    [in, ptr] BSTR bstrEnvironment, 
    [out, retval] DWORD * pdwProcessId
);

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