LDicomNet::CloseForced

#include "ltdic.h"

L_INT LDicomNet::CloseForced (bForced)

L_BOOL bForced;

/* flag */

Closes an ISCL connection. This function is available in the PACS Imaging toolkits.

Parameter	Description
bForced	Flag that indicates whether to force the disconnection. Possible values are:
	Value	Meaning
	TRUE	Kill the connection. (Force the disconnection.)
	FALSE	Request disconnection. The disconnection can be refused by a peer.

Returns

DICOM_SUCCESS	Success.
>0	An error occurred. Refer to Return Codes.

Comments

When bForced is set to TRUE, the connection is closed immediately. Therefore, it is best to determine if the ISCL message queue is empty before calling this function. To determine whether the ISCL queue is empty, use the LDicomNet::IsISCLQueueEmpty function.

Please note that LDicomNet::CloseForced (FALSE) is queued in the ISCL message queue. (It will be processed later.) LDicomNet::CloseForced (TRUE) is immediate, however.

Required DLLs and Libraries

LTDIC

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

Platforms

Win32, x64

See Also

Functions:	LDicomNet::IsISCLQueueEmpty, Class Members
Topics:	Closing an ISCL Connection
	General Integrated Secure Communication Layer (ISCL) Information

Example

L_INT LDicomNet_CloseForcedExample(LDicomNet* m_pConnectDicomNet)
{
   L_INT nRet;
   // code from simple ISCL example
   nRet = m_pConnectDicomNet->CloseForced (TRUE);
   if(nRet != DICOM_SUCCESS)
      return nRet;
   return DICOM_SUCCESS;
}