IPixEngine7::SetPlaybackEndpointAsync method

  • Article

Asynchronously sets the endpoint address used to connect to a remote engine.

Syntax

HRESULT SetPlaybackEndpointAsync(
   BOOL              bUseAuthentication,
   BSTR              endpoint,
   BSTR              sessionKey,
   RemotingVersion   remoteVersion,
   IVersionCallback* versionCallback,
   DWORD             requestCookie,
   DWORD             progressIntervalMsecs
);

Parameters

bUseAuthentication
true to use authentication; otherwise, false.

endpoint
A COM string containing the endpoint address.

sessionKey
A COM string containing the session key used for encryption.

remoteVersion
Specifies the version of the remote engine to use.

versionCallback
The address of callback used to notify the host of results.

requestCookie
A cookie that uniquely identifies the request, and can be used to signal for it to be cancelled.

progressIntervalMsecs
Not used.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Header

Vspixengine.h

See also

IPixEngine7