RtkIsAppRunnable is the RTKAPI equivalent of RtIsAppRunnable. It returns whether the provided wRTOS application binary can run. This means it has been built using a valid wRTOS SDK license for the feature on the system with the given majorVersion.
RtkIsAppRunnable can only be used by RTK drivers; it cannot be used in Windows or RTSS applications.
Syntax
NTSTATUS RtkIsAppRunnable(
[out] BOOLEAN* pResult,
[in] PUNICODE_STRING pApplicationPath,
[in] PUNICODE_STRING pFeatureName,
[in] unsigned int majorVersion
);Parameters
[out] pResult
A pointer to memory to fill with the API result if the API returns STATUS_SUCCESS. It must be allocated by the caller, or the API will return the STATUS_INVALID_PARAMETER. If the provided binary is determined to be runnable, a value of TRUE will be written into the provided memory. Otherwise, FALSE is returned.
[in] pApplicationPath
The absolute path name of an RTSS application. This parameter can never be NULL. If NULL is passed, RtkIsAppRunnable returns STATUS_INVALID_PARAMETER.
[in] pFeatureName
A string specifying a product feature code. The table below lists the common product codes for wRTOS:
| Product code | Name | Description |
|---|---|---|
|
WRTOS64 |
MaxRT wRTOS Runtime |
Allows you to use the wRTOS Subsystem, Network Link Layer (NL2), Network Relay, and Virtual Network. |
|
WNET64 |
MaxRT wRTOS Network |
Allows you to use the TCP/IP Stack. |
|
WVIS64 |
MaxRT wRTOS Vision |
Allows you to use GigE and GeniCam features with the TCP/IP Stack. Note: You must also have a WNET64 license to use Vision. |
|
WFBS64 |
MaxRT wRTOS Fieldbus |
Allows you to use available Fieldbuses (EtherCAT, other). |
|
WEMM64 |
MaxRT wRTOS E-CAT Multiple MainDevices |
Allows you to run multiple EtherCAT MainDevices. Note: This license also requires the WFB64 license. |
|
WEHST64 |
MaxRT wRTOS E-CAT High Speed Timer |
Allows the EtherCAT MainDevice to use a high-speed timer. Note: This license also requires the WFB64 license. |
|
WEHC64 |
MaxRT wRTOS E-CAT Hot Connect |
Allows the EtherCAT MainDevice to support Hot Connect. Note: This license also requires the WFB64 license. |
|
WECR64 |
MaxRT wRTOS E-CAT Cable Redundancy |
Allows the EtherCAT MainDevice to support Cable Redundancy. Note: This license also requires the WFB64 license. |
[in] majorVersion
The major version number for the product feature given in parameter pFeatureName.
| Runtime version | majorVersion value |
|---|---|
|
wRTOS 1.x |
1 |
|
Currently installed version |
0 |
Return Value
If the function succeeds, it returns STATUS_SUCCESS. If the function fails, it returns a different error code.
Possible error codes:
| Error code | Description |
|---|---|
|
STATUS_SUCCESS |
The call has succeeded. |
|
STATUS_INTERNAL_ERROR |
The call failed with an internal system error. |
|
STATUS_INVALID_PARAMETER |
An invalid length parameter was passed, or one of the required pointer parameters was NULL. |
|
STATUS_DRIVER_INTERNAL_ERROR |
The call failed with an internal driver error. |
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
wRTOS 1.0 SDK |
RtkApi.h |
RtkApi_W64.lib |
