HSDK Class Descriptions › CaUDP › bool SetUseVersionList(bool bUseVersionChooser)

bool SetUseVersionList(bool bUseVersionChooser)

Sets a boolean value for whether to pass the UDP process a Version List which would be expanded by the [VERSION] system variable.

Note: To pass a list of versions to a UDP process, this boolean is only part of the process. The following must happen:

• The actual UDP command must make use as an argument the system variable [VERSION]. The hserver will replace this variable name with the names and version number of the versions sent by the client.
• This boolean must be set before Execute() is called.
• The version chooser must be used to select the versions of items and executed. The contents of the version chooser must match the contents of the desired version list.

Owning Class

CaUDP

Arguments

bool bUseVersionChooser-to use versions in version chooser or not

Return Value

bool-what was set for this value

Example

CaUDP& rUDP = rContext.GetUDP(); rUDP.SetUseVersionList(true); CaVersionChooser &rVersionUDP = rContext.GetVersionChooser(); rVersionUDP.Clear(); rVersionUDP.SetItemName( “*.cpp” ); rVesrionUDP.Execute(); rUDP.Execute();

More information:

• HSDK Programming Fundamentals
• CaVersionChooser
• GetUserVersionList