HSDK Class Descriptions › CaUDP › bool GetUseVersionList(void)

bool GetUseVersionList(void)

Returns the current boolean setting for whether on not the versions in the VersionChooser will be sent to the UDP process during Execute().

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 desire version list.

Owning Class

CaUDP

Arguments

None

Return Value

bool-the current setting for using the version list

Example

CaUDP& rUDP = rContext.GetUDP(); bool useversion = rUDP.GetUseVersionList();

More information:

• HSDK Programming Fundamentals
• SetUsePackageList
• CaVersionChooser