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

bool SetDescription(LPCTSTR szDesc)

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

Owning Class

CaRenameItem

Arguments

LPCTSTR szDesc-the explanation

Return Value

bool-true if set succeeded, false if failed

Example

CaRenameItem& rRenameItem = rContext.GetRenameItem();
rRenameItem.SetDescription(“New naming convention”);

More information:

• HSDK Programming Fundamentals
• GetDescription