Job::SetJobParameter method
Creates or updates a job parameter with the specified name and value.
Syntax
virtual HRESULT SetJobParameter(
[in] LPCWSTR parameterName,
[in] LPCWSTR parameterValue
) = 0;
Parameters
-
parameterName [in]
-
The name of the parameter to create or update.
-
parameterValue [in]
-
A string value giving the new value of the parameter. This parameter cannot be NULL.
Return value
If successful this method returns S_OK.
The engine is currently running the job. Parameters can only be set or changed when the job is not running. AXE_E_JOB_RUNNING
If specified parameter is read-only, this medod returns AXE_E_PARAM_READ_ONLY.
If there is insufficient memory to set the parameter, this method returns E_OUTOFMEMORY.
If parameterValue was NULL, then this method returns E_POINTER.
Remarks
Managed code uses Job.JobParameter | jobParameter property.
Requirements
| Minimum supported client |
Windows 7 [desktop apps only] |
| Minimum supported server |
Windows Server 2008 R2 [desktop apps only] |
| Header |
|
| DLL |
|