WinRUIStartup()

Enables an application to specify the required version of the RUI API and to retrieve details of the API.

int WINAPI WinRUIStartup (WORD wVersionRequired,
                          LPWLUADATA* luadata);
Parameters
wVersionRequired
Specifies the version of RUI API support required. The high-order byte specifies the minor version (revision) number; the low-order byte specifies the major version number.
luadata
Returns version of RUI implementation.

Syntax

int WINAPI WinRUIStartup (WORD wVersionRequired,
                          LPWLUADATA* luadata);
Parameters
wVersionRequired
Specifies the version of RUI API support required. The high-order byte specifies the minor version (revision) number; the low-order byte specifies the major version number.
luadata
Returns version of RUI implementation.
The return value specifies whether the application was registered successfully and whether the RUI API can support the specified version number. If the value is 0, it was registered successfully and the specified version can be supported. Otherwise, the return value is one of the following values:
WLUAVERNOTSUPPORTED
The version of RUI API support requested is not provided by this particular RUI API.
WLUAINVALID
The version requested could not be determined.

Returned Values

The return value specifies whether the application was registered successfully and whether the RUI API can support the specified version number. If the value is 0, it was registered successfully and the specified version can be supported. Otherwise, the return value is one of the following values:
WLUAVERNOTSUPPORTED
The version of RUI API support requested is not provided by this particular RUI API.
WLUAINVALID
The version requested could not be determined.

This call is intended to aid in compatibility with future versions of the API. The current version is 1.0. See also WinRUICleanup().

Usage Notes

This call is intended to aid in compatibility with future versions of the API. The current version is 1.0. See also WinRUICleanup().