Technical Reference > Graphics Builder Automation Interface > Page Properties Functions > PageEnvironmentRemove

PageEnvironmentRemove

Removes an environment variable from the current page. This function will return an error if an environment variable with the specified name does not exist.

Syntax

PageEnvironmentRemove(name)

name:

Specifies the name of the environment variable to be removed.

Return Value

0 (zero) if successful, otherwise an error is returned.

Example

Deleting an existing environment variable

GraphicsBuilder.PageEnvironmentRemove("Foo")

Updating an existing environment variable

GraphicsBuilder.PageEnvironmentRemove("Foo")
GraphicsBuilder.PageEnvironmentAdd("Foo", "Bar2")

Related Functions

PageEnvironmentFirst