IXtfApplicationClient::Deploy Method

Deploys the app.

Syntax

public:
HRESULT Deploy(
         LPCWSTR pszDeployFilepath,
         BOOL fRemoveExtraFiles,
         IXtfDeployCallback *pCallback,
         BOOL *pfCanceled,
         int *pdwResult,
         LPBSTR pbstrPackageFullName,
         LPBSTR pbstrAumidJson
)

Parameters

pszDeployFilepath
Type: LPCWSTR

Pointer to the filepath to deploy to.

fRemoveExtraFiles
Type: BOOL

Specify true to remove files that are already on the development console but are not part of the deployment package; false to keep them.

pCallback
Type: IXtfDeployCallback *

Pointer to the IXtfDeployCallback callback to call when a trackable action occurs during the deployment. Pass nullptr if you do not want callbacks during deployment.

pfCanceled
Type: BOOL *

Pointer that receives a Boolean value that indicates whether deployment was canceled.

pdwResult
Type: int *

Pointer that receives the HRESULT of the deployment operation. For example, if an open file handle prevents a file from being deleted this value would contain the error code.

pbstrPackageFullName
Type: LPBSTR

Pointer that receives the full name of the deployed app package, including the version number, architecture, and culture.

pbstrAumidJson
Type: LPBSTR

Pointer that receives a JSON representation of a list of the AUMIDs associated with the app package. All AUMIDs in the list will share the same PackageFamilyName, but will have different AppIds after the exclamation mark (“!”).

Return value

Type: HRESULT

HRESULT of the connection status and parameter validation.

Remarks

This is a synchronous method.

Requirements

Header: Declared in xtfapplication.h.

Library: Use xtfapplication.lib.