18.08.2013 Views

Virtual Disk API Programming Guide - Documentation - VMware

Virtual Disk API Programming Guide - Documentation - VMware

Virtual Disk API Programming Guide - Documentation - VMware

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

B<br />

Errors Codes and Open Source B<br />

This appendix contains the following sections:<br />

“Finding Error Code <strong>Documentation</strong>” on page 95<br />

“Troubleshooting Dynamic Libraries” on page 95<br />

“Open Source Components” on page 96<br />

Finding Error Code <strong>Documentation</strong><br />

For a list of <strong>Virtual</strong> <strong>Disk</strong> <strong>API</strong> error codes, see the online reference guide Introduction to the Vix<strong>Disk</strong>Lib <strong>API</strong>:<br />

Windows – C:\Program Files\<strong>VMware</strong>\<strong>VMware</strong> <strong>Virtual</strong> <strong>Disk</strong> Development Kit\doc\intro.html<br />

Linux – /usr/share/doc/vmware-vix-disklib/intro.html<br />

In a Web browser, click the Error Codes link in the upper left frame, and click any link in the lower left frame.<br />

The right‐hand frame displays an alphabetized list of error codes, with explanations.<br />

Association With VIX <strong>API</strong> Errors<br />

The <strong>Virtual</strong> <strong>Disk</strong> <strong>API</strong> shares many errors with the VIX <strong>API</strong>, which explains the VIX prefix. The error codes for<br />

the VIX <strong>API</strong> are likely to be the same, or almost the same as, a comparable release of the VDDK.<br />

For information about the VIX <strong>API</strong>, including its online reference guide to functions and error codes, see the<br />

developer support section of the <strong>VMware</strong> Web site:<br />

https://www.vmware.com/support/developer/vix‐api/index.html<br />

Interpreting Errors Codes<br />

A VIX error is a 64‐bit value. A value of VIX_OK indicates success, but otherwise (if there is an error), several<br />

bit regions in the 64‐bit value might be set. The least significant 16 bits are set to the error code described for<br />

VIX errors. More significant bit fields might be set to other values.<br />

As for the VIX <strong>API</strong>, use the macro VIX_ERROR_CODE(err) to mask off bit fields not used by the VDDK.<br />

Troubleshooting Dynamic Libraries<br />

On Windows, the SSL library is placed in the same directory as other vix<strong>Disk</strong>Lib dynamically loaded libraries.<br />

On Linux, functions that load the libraries libssl.so.0.9.8 and libcrypto.so.0.9.8 do the following:<br />

1 Attempt to load them from the environment’s LD_LIBRARY_PATH location.<br />

2 Next, attempt to load them from the directory where libvix<strong>Disk</strong>Lib.so is located.<br />

3 Next, attempt to load them from the directory where the executable is located.<br />

4 Failing that, exit with an error.<br />

<strong>VMware</strong>, Inc. 95

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!