DLN_CLOSE_HANDLE

DLN_CLOSE_HANDLE Command

Go to response

The DLN_CLOSE_HANDLE command closes the handle to the opened DLN-series adapter (stream).

  typedef struct
  {
     DLN_MSG_HEADER header;
  } __PACKED_ATTR DLN_CLOSE_HANDLE_CMD;

Parameters:

header

Defines the DLN message header DLN_MSG_HEADER. The header contains several predefined fields and is used to identify and route messages. When sending the command, a user must fill the following fields:

  • size - The size of the message. Must be equal to the size of the DLN_CLOSE_HANDLE_CMD structure.
  • msgId - Defines the message. For the DLN_CLOSE_HANDLE command it must be set to 0x0023. You can use the DLN_MSG_ID_CLOSE_HANDLE constant.
  • echoCounter - Can be used to link a command to a response. The response will have the same echoCounter value. This field can be any numerical value from 0 to 0xFFFF (65536).
  • handle - A handle to the DLN-series adapter. You may specify either a handle to a specific device (stream) or the HDLN_ALL_DEVICES value.

DLN_CLOSE_HANDLE Response

Go to command

The adapter sends the DLN_CLOSE_HANDLE response after the command execution. The result field informs a user if the connection has been successfully closed.

  typedef struct
   {
      DLN_MSG_HEADER header;
      DLN_RESULT result;
   } __PACKED_ATTR DLN_CLOSE_HANDLE_RSP;

Parameters:

header

Defines the DLN message header DLN_MSG_HEADER. The response header contains the following fields:

  • size - The size of the message. It is equal to the size of the DLN_CLOSE_HANDLE_RSP structure.
  • msgId - Defines the message. For the DLN_CLOSE_HANDLE response it is set to 0x0023. The DLN_MSG_ID_CLOSE_HANDLE constant can be used.
  • echoCounter - Links a command to a response. The echoCounter value is copied from the respective command header.
  • handle - A handle to the DLN-series adapter. Can be either a handle to a specific device (stream) or the HDLN_ALL_DEVICES value.
result

Contains the result of the command execution. The following values are available:

  • DLN_RES_SUCCESS - the handle to the device has been successfully closed.