Share via


ITask::SetEnvironmentVariable method

Sets the task-specific environment variable.

Syntax

HRESULT SetEnvironmentVariable(
  [in] BSTR Name,
  [in] BSTR Value
);

Parameters

  • Name [in] The name of the environment variable.

  • Value [in] The value of the environment variable.

Return value

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.

Remarks

The length of all environment variables specified for the task is limited to 2,048 Unicode characters.

To set cluster-wide environment variables, call the ICluster::SetEnvironmentVariable method.

The environment variables that are made available to the task include variables set using this method, those set using the SetEnvironmentVariable method, and the cluster-wide environment variables that are defined in the "Use Environment Variables" section of the Compute Cluster Server User Operations.

To retrieve this variable from inside your task, call the Win32 function GetEnvironmentVariable.

Requirements

Product

Compute Cluster Pack Client Utilities

Type library

Ccpapi.tlb

See also

ICluster::SetEnvironmentVariable

ITask

ITask::get_EnvironmentVariables