HSDK Class Descriptions › CaCheckout › bool SetPathOption(HINT32 iOption)

bool SetPathOption(HINT32 iOption)

Sets the Path Option for this process. Files are checked out to the directory structure in locations related to the view path, client directory, and the path option.

Note: The following are the allowable values for the Path Option. They are defined in an include file built into the project.

• CO_OPTION_PRESERVE-Check out each new version to its existing client path location that mirrors the location in the view path.
• CO_OPTION_PRESERVE_AND_CREATE-Check out each new version to its client path location that mirrors the location in the view path and create the client path if it does not yet exist.
• CO_OPTION_ALL_ITEM_TO_SAME_DIRECTORY-Check out each new version to the single client path location specified.

Owning Class

CaCheckout

Arguments

HINT32 iOption-the Path Option.

Return Value

True if success, false if fail

Example

CaCheckout& rCheckout = rContext.GetCheckout(); bool bResult = rCheckout.SetPathOption (CO_OPTION_PRESERVE_AND_CREATE);

More information:

• HSDK Programming Fundamentals
• CaContext
• GetPathOption
• SetClientDir
• SetViewPath