Share via

XtfCloseCredentialInfoList

  • Article

Frees resources associated with an XtfNetworkCredentials object returned by XtfGetCredentialInfoList.

Syntax

HRESULT XtfCloseCredentialInfoList(
         XtfNetworkCredentials credentialInfo
)

Parameters

credentialInfo
Type: XtfNetworkCredentials

[in] An XtfNetworkCredentials object created by calling XtfGetCredentialInfoList.

Return value

Type: HRESULT

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

Remarks

Use XtfAddCredential to add credentials. Use XtfRemoveCredential to remove credentials. Use XtfGetCredentialInfoList, XtfGetCredentialInfoCount, XtfGetCredentialServerName, and XtfGetCredentialUserName to enumerate the current list of stored credentials. Use XtfCloseCredentialInfoList to free the XtfNetworkCredentials returned by XtfGetCredentialInfoList.

See XtfGetCredentialInfoList for an example of how to use this API.

Requirements

Header: xtfapi.h

Library: XtfApi.lib

Supported platforms: Windows (for Xbox console tools)

See also

XTF Transport Errors (NDA topic)
Additional Xtf APIs