Name

ErrorIndicatesSuccess

Description

HRESULT
ErrorIndicatesSuccess([in] ULONGLONG err,
                      [out,retval] VARIANT_BOOL* isSuccess);

Determines if the error value returned by a VIX function indicates that the function call completed successfully.

Parameters

err
An error value returned from a VIX functions.
isSuccess
Returns whether the operation that returned 'err' was a success.

Return Value

HRESULT

Remarks

Side Effects

None.

Requirements

VixCOM.h, since VMware Workstation 6.0.

Example

In VBScript:
Dim job
Dim err

' Power on the virtual machine in headless mode.
Set job = vm.PowerOn(VixCOM.Constants.VIX_POWEROP_NORMAL, Nothing, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesSuccess(err) Then
   ' Perform some operation on the powered on virtual machine...
End If

Copyright (C) 2007-2010 VMware, Inc. All rights reserved.