HSDK Class Descriptions › CaRenamePath › bool SetDescription(LPCTSTR szDesc)

bool SetDescription(LPCTSTR szDesc)

Sets a description to annotate why the item is being renamed.

Owning Class

CaRenamePath

Arguments

LPCTSTR szDesc-the explanation

Return Value

bool-true if set succeeded, false if failed

Example

CaRenamePath& rRenamePath = rContext.GetRenamePath();
rRenamePath.SetDescription(“New naming convention”);

More information:

• HSDK Programming Fundamentals
• GetDescription