flash.desktop

# NativeProcessStartupInfo - AS3

Package | flash.desktop
Class | public class NativeProcessStartupInfo
Inheritance | NativeProcessStartupInfo Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

This class provides the basic information used to start a process on the host operating system. It is constructed and passed to the `start()` method of a NativeProcess object.

Native process access is only available to AIR applications installed with native installers (applications in the extended desktop profile).

Related API Elements

NativeProcess.html#start()

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | arguments : Vector.<String> The command line arguments that will be passed to the process on startup. | NativeProcessStartupInfo
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | executable : File The File object that references an executable on the host operating system. | NativeProcessStartupInfo
|  | workingDirectory : File The File object that references the initial working directory for the new native process. | NativeProcessStartupInfo

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | NativeProcessStartupInfo() Constructs an empty NativeProcessStartupInfo object. | NativeProcessStartupInfo
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### arguments

property

`arguments:Vector.<String>`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The command line arguments that will be passed to the process on startup.

Each string in the `arguments` Vector will be passed as a separate argument to the executable, regardless of what characters the string contains. In other words, there is an exact one-to-one correspondence; no re-interpretation occurs. AIR automatically escapes any characters in the string that need to be escaped (such as space characters).

Implementation
`public function get arguments():Vector.<String>`
`public function set arguments(value:Vector.<String>):void`

### executable

property

`executable:File`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The File object that references an executable on the host operating system. This should be the full path to the executable including any extension required.

Note: On Mac OS, to launch an executable within an application bundle, be sure to have the path of the File object include the full path the the executable (within the bundle), not just the path to the app file.

Implementation
`public function get executable():File`
`public function set executable(value:File):void`
Throws

| `ArgumentError` — if the value specified is `null`, if it references a directory, or if it references a file that does not exist.

### workingDirectory

property

`workingDirectory:File`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The File object that references the initial working directory for the new native process. If assigned a value where `isDirectory` is false, an ArgumentError is thrown.

Implementation
`public function get workingDirectory():File`
`public function set workingDirectory(value:File):void`
Throws

| `ArgumentError` — if the value doesn't exist or is not a directory

Constructor Detail

### NativeProcessStartupInfo

()
Constructor

`public function NativeProcessStartupInfo()`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Constructs an empty NativeProcessStartupInfo object.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00