Edit

Share via

CredRenameA function (wincred.h)

  • Article

[CredRename is no longer supported. Starting with Windows Vista, calls to CredRename always return ERROR_NOT_SUPPORTED.]

The CredRename function renames a credential in the user's credential set. The credential set used is the one associated with the logon session of the current token. The token must not have the user's SID disabled.

Syntax

BOOL CredRenameA(
  [in] LPCSTR OldTargetName,
  [in] LPCSTR NewTargetName,
  [in] DWORD  Type,
  [in] DWORD  Flags
);

Parameters

[in] OldTargetName

Pointer to a null-terminated string that contains the current name of the credential to be renamed.

[in] NewTargetName

Pointer to a null-terminated string that contains the new name for the credential.

[in] Type

Type of the credential to rename. Must be one of the CRED_TYPE_* defines.

[in] Flags

Flags to control the operation of the function. Currently reserved and must be zero.

Return value

The function returns TRUE on success and FALSE on failure. The GetLastError function can be called to get a more specific status code. The following status codes can be returned:

  • ERROR_NOT_FOUND

    There is no credential with the specified OldTargetName.

  • ERROR_ALREADY_EXISTS

    There is already a credential or type Type and named NewTargetName.

  • ERROR_NO_SUCH_LOGON_SESSION

    The logon session does not exist or there is no credential set associated with this logon session. Network logon sessions do not have an associated credential set.

  • ERROR_INVALID_FLAGS

    A flag that is not valid was specified for the Flags parameter.

Remarks

Note

The wincred.h header defines CredRename as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header wincred.h
Library Advapi32.lib
DLL Advapi32.dll