Share via

OPTNAMECHANGEPFN

  • Article

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

This is a callback function specified in a call to the SccSetOption (using option SCC_OPT_NAMECHANGEPFN) and is used to communicate name changes made by the source control plug-in back to the IDE.

Signature

typedef void (*OPTNAMECHANGEPFN)(
   LPVOID pvCallerData,
   LPCSTR pszOldName,
   LPCSTR pszNewName
);

Parameters

pvCallerData

[in] User value specified in a previous call to the SccSetOption (using option SCC_OPT_USERDATA).

pszOldName

[in] The original name of the file.

pszNewName

[in] The name the file was renamed to.

Return value

None.

Remarks

If a file is renamed during a source control operation, the source control plug-in can notify the IDE about the name change through this callback.

If the IDE does not support this callback, it will not call the SccSetOption to specify it. If the plug-in does not support this callback, it will return SCC_E_OPNOTSUPPORTED from the SccSetOption function when the IDE attempts to set the callback.

See also