LDicomNet::SendCGetResponse

Summary

Sends a C-GET-RSP message to a peer member of a connection. This function is available in the PACS Imaging Toolkit.

Syntax

#include "ltdic.h"

L_INT LDicomNet::SendCGetResponse(nPresentationID, nMessageID, pszClass, nStatus, nRemaining, nCompleted, nFailed, nWarning, pDS)

Parameters

L_UCHAR nPresentationID

Presentation ID. The presentation ID provides information about both the class type of the data and the transfer syntax to use when transferring the data.

L_UINT16 nMessageID

Message ID. Each message sent by a member of a connection should have a unique ID. Since a member of a connection may send several messages, this ID allows that member to identify when a specific request has been completed.

L_TCHAR * pszClass

Class affected by the request. This will be an SOP Class or an SOP MetaClass.

L_UINT16 nStatus

The status of the original request. For a list of possible values, refer to Status Constants.

L_UINT16 nRemaining

Number of remaining instances to search.

L_UINT16 nCompleted

Number of instances searched.

L_UINT16 nFailed

Number of instances that failed the search.

L_UINT16 nWarning

Number of instances in which warnings occurred.

LDicomDS *pDS

Pointer to the data set that contains the information retrieved as a result of the call to LDicomNet::SendCGetRequest.

Returns

Value	Meaning
0	SUCCESS
>0	An error occurred. Refer to Return Codes.

Comments

LDicomNet::SendCGetResponse is sent by the SCP in response to an LDicomNet::SendCGetRequest call placed by an SCU. This generates a call to LDicomNet::OnReceiveCGetResponse on the SCU.

As an example, suppose an SCU requests an SCP to search all CT class instances for specific data. If the SCP has three CT class instances present, it must search all three instances for the required data. During the search, LDicomNet::SendCGetResponse may be called multiple times. The table below gives examples of possible parameter values for the calls made to LDicomNet::SendCGetResponse during the search:

Point within search	nStatus	nRemaining	nCompleted	nFailed	nWarning
Finished 1st instance	COMMAND_STATUS_PENDING	2	1	0	0
Finished 2nd instance	COMMAND_STATUS_PENDING	1	2	1	1
Finished the search	COMMAND_STATUS_SUCCESS	0	3	1	1

After the first instance is searched, there are 2 remaining instances to search (nRemaining), there is 1 instance that has been completed (nCompleted), no instances have failed the search (nFailed), and there are no warnings(nWarning).

After the second instance is searched, there is 1 remaining instance to search (nRemaining), there are 2 instances that have been completed (nCompleted), 1 instance has failed the search (nFailed), and there is one warning (nWarning).

After the last instance has been searched, there are 0 remaining instances to search (nRemaining), there are 3 instances that have been completed (nCompleted), 1 instance has failed the search (nFailed), and there is one warning (nWarning).

The instance that failed may have failed because one data element you were searching for was not in the instance. For example, you may have included "Patient Birth Date" in the elements to search for and one instance did not include "Patient Birth Date".

Information about the warning may be found in the data set that is returned.