document that initialization order does not predictably determine host api indexes

This commit is contained in:
Ross Bencina 2016-09-03 16:28:39 +10:00
commit a3d9f6cd3c

View file

@ -293,9 +293,11 @@ typedef enum PaHostApiTypeId
hostApiTypeIds parameter is not available.
The paInvalidHostApi error indicates that there was a problem with the
hostApiTypes array. E.g. it contained duplicate entries.
hostApiTypes array. E.g. it contained invalid or duplicate entries.
@note The host API initialization order determines default devices.
There is no predictable relationship between the order that host APIs appear
in hostApiTypes, and their hostApiIndexes assigned by Pa_Initialize().
@see PaHostApiTypeId
*/