Previous Topic: OpenSoftwareJobContainerListRecursiveNext Topic: OpenSoftwareJobContainerSoftwareJobList


OpenSoftwareJobContainerListRecursive3

The OpenSoftwareJobContainerListRecursive3 method opens a list of software job containers. The method returns the total number of software job containers in the list, and a handle to the list that you can use for further calls to GetSoftwareJobContainersRecursive3.

This method also includes the functionality that helps you manage the custom administrator message. The method takes the sequence SoftwareJobContainerPropertiesRequired3 that includes a parameter to set the requirement for the userMessage field in the retrieved software job container properties.

Parameters

xsd:string sessionId (m)

Specifies the session identifier obtained from the login method of the web service.

xsd:string softwareJobContainerId

Specifies the software job container identifier. If no value is provided, the root container is opened.

SoftwareJobContainerPropertiesRequired3 softwareJobContainerPropertiesRequired3 (m)

Specifies the properties that are required when getting a software job container from the list.

Return Values

xsd:long OpenListHandle

Returns a numeric handle to a list of software job containers that you can pass to GetSoftwareJobContainersRecursive3.

xsd:long totalNoOfSoftwareJobContainers

Returns the total number of software job containers in the list for which the handle has been returned.

Remarks

None

More information:

SoftwareJobContainerPropertiesRequired3