COMStatus
(Engine-Level Function)
Description | Returns the last status information that occurred for a specified COM client interface. |
Returns | Varies |
Usage | Script Only. |
Function Groups | COM |
Related to: | ActiveX | COMClient | COMEvent |
Format | ComStatus(COMClientInterface [, Options]) |
Parameters |
COMClientInterface |
Required. A COM client interface handle returned from a COMClient or ActiveX statement. |
Options |
Optional. Any numeric expression. Set to 0 to return the Windows API error code. Set to 1 to return a text message representation of the Windows API error code. Defaults to 0 if missing or Invalid. |
Comments | The value returned indicates the success or failure of the last operation attempted through the specified COM client interface. Depending on the Options parameter, this function returns either the Windows API error code or a text value containing an ASCII representation of the error code. There is no guarantee that all error codes can successfully be translated into a text representation. |
Example:
See: COMClient