IWorkspaceScriptable2::StartWorkspaceEx method

Associates user credentials and certificates with a connection ID; also contains additional security and UI elements.

Syntax


HRESULT StartWorkspaceEx(
  [in] BSTR bstrWorkspaceId,
  [in] BSTR bstrWorkspaceFriendlyName,
  [in] BSTR bstrRedirectorName,
  [in] BSTR bstrUserName,
  [in] BSTR bstrPassword,
  [in] BSTR bstrAppContainer,
  [in] BSTR bstrWorkspaceParams,
  [in] LONG lTimeout,
  [in] LONG lFlags
);

Parameters

bstrWorkspaceId [in]

A string that contains the connection ID.

bstrWorkspaceFriendlyName [in]

The friendly name of the workspace to display in the UI.

bstrRedirectorName [in]

String containing the name of the redirector.

bstrUserName [in]

A string that contains a user name.

bstrPassword [in]

A string that contains a password.

bstrAppContainer [in]

A string containing the app container for the workspace.

bstrWorkspaceParams [in]

A string that contains one or more Secure Hash Algorithm 1 (SHA-1) hashes of signing certificates to associate with the specified connection ID. The hash values should be in hexadecimal string format and delimited by semicolons.

lTimeout [in]

The time period, in minutes, after which the credentials are deleted.

lFlags [in]

A flag that specifies properties of the user credentials. This can be a bitwise OR of the following values.

WKS_FLAG_CLEAR_CREDS_ON_LAST_RESOURCE (1 (0x1))

Delete credentials as soon as the last RemoteApp application is closed.

WKS_FLAG_PASSWORD_ENCRYPTED (2 (0x2))

The password is encrypted.

WKS_FLAG_CREDS_AUTHENTICATED (4 (0x4))

The user credentials are verified. If this flag is not set, you must call the OnAuthenticated method before using the credentials.

Return value

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT value that indicates the error. Possible values include, but are not limited to, those in the following list.

HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS)

The credential store already has an entry for the specified connection ID that contains credentials for a different user, and at least one active connection exists for this connection ID.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

IDL

WorkspaceRuntime.idl

Type library

WkspRt.exe

IID

CLSID_Workspace is defined as 4F1DFCA6-3AAD-48E1-8406-4BC21A501D7C

IID_IWorkspaceScriptable2 is defined as EFEA49A2-DDA5-429D-8F42-B33BA2C4C348

See also

IWorkspaceScriptable3
IWorkspaceScriptable2

 

 

Show: