Altitude Property

The altitude the class's system driver should use.

Syntax

 cbprocess.getAltitude([callback])
 cbprocess.setAltitude( altitude, [callback])

Default Value

400055

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAltitude([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAltitude([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property specifies the altitude that the class's system driver should use. A driver's altitude determines its absolute position in the stack of filter drivers; drivers with higher altitudes are attached towards the top of the stack, closer to user mode, which allows them to process requests earlier.

Microsoft's documentation is unclear about how altitudes should be chosen for process manager filter drivers; please refer to the Driver Altitudes topic for more information. The default value of this property is 400055 (which isn't registered with Microsoft), but applications can likely choose any value they desire. If the specified altitude is already in use by another driver, the class's driver will behave in the manner specified by the StrictAltitude property.

Data Type

Integer