XtfRemoveCredential

Removes credentials from the given console. Use XtfAddCredential add credentials.

Syntax

HRESULT XtfRemoveCredential(
         LPCWSTR address,
         LPCWSTR serverName
)  

Parameters

address
Type: LPCWSTR 

[in] Address of the console.

serverName
Type: LPCWSTR 

[in] Target server or share name.

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, XtfGetCredentialCount, 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.

Note When the console is rebooted all stored credentials are lost and must be added again.

Requirements

Header: Declared in XtfApi.h.

Library: Use XtfApi.lib.