XtfRegisterNetworkSharePackage

Article
06/22/2023

Registers a package for Run from PC Deployment (NDA topic)Authorization required.

Note

In this release, the password text is not encrypted when it is passed over the network to the console by XtfRegisterNetworkSharePackage. See Run from PC Deployment (NDA topic)Authorization required for more information on how to create a low privilege user account for use with this feature.

Syntax

HRESULT XtfRegisterNetworkSharePackage(
         LPCWSTR address,
         LPCWSTR sharePath,
         LPCWSTR userName,
         LPCWSTR password,
         XtfPackageInfo *packageInfo
)

Parameters

address
Type: LPCWSTR

[in] Address of the console.

sharePath
Type: LPCWSTR

[in] The path to the share on a Dev PC to register.

userName
Type: LPCWSTR

[in] User name to use in domain\user format. Can be L"".

password
Type: LPCWSTR

[in, out] Password for the user. Not encrypted. Can be L"".

packageInfo
Type: XtfPackageInfo *

[out] Package information object about the package that was registered.

Return value

Type: HRESULT

A return value of S_OK indicates the function succeeded. Any other value indicates an unexpected error occurred.

Remarks

If userName and password are equal to L"", the credentials registered for sharePath using XtfAddCredential are used.

Use XtfGetPackageFullName, XtfGetCountofAppUserModelIds, and XtfGetAumid to retrieve information from the packageInfo object. Use XtfClosePackageInfo to free the packageInfo object when you are done with it.

Requirements

Header: xtfapi.h

Library: XtfApi.lib

Supported platforms: Windows (for Xbox console tools)

Share via