L_VecDlgNewGroup

Summary

Brings up the Vector New Group dialog. This function is available in the LEADTOOLS Vector Imaging Toolkit.

Syntax

#include "ltvdlg.h"

L_LVDLG_API L_INT L_VecDlgNewGroup(hWnd, pVector, pGroupDesc, pGroup, dwFlags, pfnCallback, pUserData)

Parameters

L_HWND hWnd

Handle of the window that owns the dialog.

pVECTORHANDLE pVector

Pointer to the vector handle that references the vector image to be affected by the new group dialog.

pVECTORGROUPDESC pGroupDesc

Pointer to a VECTORGROUPDESC structure that contains new group parameters. The values present in the structure when the function is called are used to initialize the dialog. If this parameter is NULL when the function is called, default values are used to initialize the dialog. When this function returns, if this parameter is not NULL, the structure pointed to by pGroupDesc is updated with the values entered through the dialog.

pVECTORGROUP pGroup

Pointer to a VECTORGROUP structure. If this parameter is not NULL and VECTOR_DLG_AUTO_PROCESS is specified in dwFlags, the structure pointed to by pGroup will be updated with the newly added group structure.

L_UINT32 dwFlags

User interface flags for dialog. Determines the layout and action of the dialog.

Value Meaning
VECTOR_DLG_AUTO_PROCESS [0x80000000] Process the vector on OK.
VECTOR_DLG_NO_RETURN_DUPLICATE [0x00000001] Do not return duplicate group names.
VECTOR_DLG_ENABLE_HELPBUTTON [0x00000002] Enable Help button.

LVCOMMDLGHELPCB pfnCallback

Pointer to an optional help callback function.

If you do not wish to provide help to this dialog, use NULL as the value of this parameter. To provide help to this dialog, use the function pointer as the value of this parameter. The callback function must adhere to the prototype described in LVCOMMDLGHELPCB.

L_VOID * pUserData

Void pointer that you can use to pass one or more additional parameters that the callback function needs.

To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID *. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure. If the additional parameters are not needed, you can pass NULL in this parameter.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

Required DLLs and Libraries

See Also

Functions

Topics

Example

This example will add a new group to the given vector handle.

L_INT VecDlgNewGroupExample( 
   HWND hWnd, 
   pVECTORHANDLE pVector) 
{ 
   L_INT nRet; 
 
   nRet = L_VecDlgNewGroup( 
      hWnd, 
      pVector, 
      NULL, 
      NULL, 
      VECTOR_DLG_AUTO_PROCESS, 
      NULL, 
      NULL); 
 
   return nRet; 
} 

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Vector C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.