IWorkspaceScriptable::StartWorkspace method (workspaceruntime.h)

Article
02/22/2024

Associates user credentials and certificates with a connection ID.

Syntax

HRESULT StartWorkspace(
  [in] BSTR bstrWorkspaceId,
  [in] BSTR bstrUserName,
  [in] BSTR bstrPassword,
  [in] BSTR bstrWorkspaceParams,
  [in] LONG lTimeout,
  [in] LONG lFlags
);

Parameters

[in] bstrWorkspaceId

A string that contains the connection ID.

[in] bstrUserName

A string that contains a user name.

[in] bstrPassword

A string that contains a password.

[in] bstrWorkspaceParams

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.

[in] lTimeout

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

[in] lFlags

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.

Requirements

Requirement	Value
Minimum supported client	Windows 7
Minimum supported server	Windows Server 2008 R2
Target Platform	Windows
Header	workspaceruntime.h

Share via