5/13/2011

This method is used by the device imaging component to query for additional information about a device imaging deployment.

Syntax 

HRESULT GetDeploymentJobProperty(
  const BSTR DeploymentJobID, 
  const BSTR PropertyName,
  VARIANT* pPropertyValue
);

Parameters

DeploymentJobID

[in] ID of the device imaging deployment.

PropertyName

[in] Name of the device property.

pPropertyValue

[out] Pointer to the value of the specified device property.

Return Value

The following table shows the possible return values.

Value

Description

S_OK

Success.

E_INVALIDARG

Invalid parameter passed to the method.

E_OUTOFMEMORY

OUT parameter contains insufficient buffer.

E_FAIL

OUT parameter is invalid (access violation).

Remarks

The following table describes the possible values for PropertyName.

Property

Description

RemoteServer

The name of the remote server.

DeploymentName

Unique user-friendly name for the device imaging deployment.

DeploymentComment

Simple description or note about the device imaging deployment.

DeploymentStatus

Current status of the device imaging deployment.

DeviceIDList

String of all devices that belong to this device imaging deployment.

CollectionID

The existing collection to which the device imaging deployment is targeted.

ImageFile

The location of an image file. This can be a UNC path, but could also be any string that identifies the image file. For example, a GUID.

StartTimeEnabled

TRUE if the job is to start at a given time.

StartTimeIsGMT

TRUE if StartTimeis in Coordinated Universal Time (Greenwich Mean Time).

StartTime

Time for the device imaging deployment to start.

ExpirationTimeEnabled

TRUE if the device imaging deployment is to end at a given time.

ExpirationTimeIsGMT

TRUE if EndTimeis in Coordinated Universal Time (Greenwich Mean Time).

ExpirationTime

Time for the device imaging deployment to expire.

See Also