Commit 51f5abc68c464dfefdee7de83bad263ab0d13041
1 parent
92db52b0
Exists in
master
and in
3 other branches
Updating funcion documentation.
Showing
1 changed file
with
11 additions
and
4 deletions
Show diff stats
src/include/lib3270.h
| @@ -1273,11 +1273,18 @@ | @@ -1273,11 +1273,18 @@ | ||
| 1273 | 1273 | ||
| 1274 | /** | 1274 | /** |
| 1275 | * | 1275 | * |
| 1276 | - * @brief Overrides the default value for the unlock delay. | 1276 | + * @brief Set the unlock delay in milliseconds. |
| 1277 | * | 1277 | * |
| 1278 | - * Overrides the default value for the unlock delay (the delay between the host unlocking the | ||
| 1279 | - * keyboard and lib3270 actually performing the unlock). | ||
| 1280 | - * The value is in milliseconds; use 0 to turn off the delay completely. | 1278 | + * When lib3270 sends the host an AID (the Enter, Clear, PF or PA actions), |
| 1279 | + * it locks the keyboard until the host sends a reply to unlock it. Some | ||
| 1280 | + * hosts unlock the keyboard before they are actually finished processing | ||
| 1281 | + * the command, which can cause scripts to malfunction subtly. | ||
| 1282 | + * | ||
| 1283 | + * To avoid this, lib3270 implements a hack to briefly delay actually | ||
| 1284 | + * unlocking the keyboard. When the unlock delay is not 0, the keyboard | ||
| 1285 | + * unlock will be delayed for the number of milliseconds set by this call. | ||
| 1286 | + * | ||
| 1287 | + * Setting the delay to 0 disables the hack. | ||
| 1281 | * | 1288 | * |
| 1282 | * @param session lib3270 session. | 1289 | * @param session lib3270 session. |
| 1283 | * @param delay Delay in milliseconds. | 1290 | * @param delay Delay in milliseconds. |