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

bool SetDescription(LPCTSTR szDesc)

Sets a description to annotate why the path is being removed.

Owning Class

CaRemovePath

Arguments

LPCTSTR szDesc-the explanation

Return Value

bool-true if set succeeded, false if failed

Example

CaRemovePath& rRemovePath = rContext.GetRemovePath();
rRemovePath. SetDescription(“New naming convention”);

More information:

• HSDK Programming Fundamentals
• GetDescription