OPTNAMECHANGEPFN

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at OPTNAMECHANGEPFN.

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.

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

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.

None.

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.

Callback Functions Implemented by the IDE
SccSetOption