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

bool SetDescription(LPCTSTR szDesc)

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

Owning Class

CaMovePath

Arguments

LPCTSTR szDesc-the explanation

Return Value

bool-true if set succeeded, false if failed

Example

CaMovePath& rMovePath = rContext.GetMovePath();
rMovePath. SetDescription(“New naming convention”);

More information:

• HSDK Programming Fundamentals
• GetDescription