Collapse All Expand All

LDicomPrintSCU::GetDefaultOverlayBoxParameters

#include "ltdic.h"

L_INT LDicomPrintSCU::GetDefaultOverlayBoxParameters(pParameters, uStructSize) const

pOVERLAYBOXPARAMETERS pParameters;	/* Image Overlay Box parameters */
L_UINT uStructSize;	/* size of the structure */

Sets the members of the specified OVERLAYBOXPARAMETERS structure to default values.

Parameter	Description
pParameters	Pointer to an OVERLAYBOXPARAMETERS structure. The function will set the memebers of this structure to default values.
uStructSize	Size of the structure pointed to by pParameters.

Returns

0	The function was successful.
<> 0	An error occurred. Refer to Return Codes.

Comments

The function will set each the members nOverlayOriginRow and nOverlayOriginColumn to 1. The member nMagnifyToNumberOfColumns will be set to a negative value and all string members will be set to NULL. The member uStructSize will be set to the size of the structure.

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:	Class Members, LDicomPrintSCU::CreateOverlayBox, LDicomPrintSCU::UpdateOverlayBox
Topics:	Print Management SCU
	DICOM Print Management Service Class User: Functions

Example

For an example, refer to LDicomPrintSCU::UpdateImageBox.