Category Selection, Object ProSelbuffer

Function ProSelbufferSelectionAdd


Description
Programmatically add an item to the buffer of the currently active selection tool.
Replacement in Object TOOLKIT: pfcSelectionBuffer::AddSelection
Synopsis
#include <ProSelbuffer.h>
ProErrorProSelbufferSelectionAdd(
ProSelection object
/* (In)
The object to add to the buffer. This selection must reference an item that could have been selected in the current model (its owner, component path, and/or drawing view values must be properly constructed).
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSThe input argument was invalid.
PRO_TK_CANT_ACCESSThere is no Object/Action selection tool active.
PRO_TK_INVALID_ITEMThe selection does not correctly reference the current model.
PRO_TK_NOT_DISPLAYEDThe item is not currently displayed and so cannot be added to the buffer.
PRO_TK_BAD_CONTEXTThe selection cannot be added to the buffer in combination with one or more objects that are already in the buffer (e.g. geometry and features selected at the same time).
PRO_TK_GENERAL_ERRORThe function failed to add the requested item to the buffer.
PRO_TK_CANT_MODIFYBuffer modification is prohibited.
PRO_TK_MULTIBODY_UNSUPPORTEDinput collection is not supported in multi-body models.

Manual References:

  1. User Interface: Selection: Adding Items to the Selection Buffer
  2. User Interface: Selection: Adding Items to the Selection Buffer

Sample Code References:

  1. pt_af_examples ( PTAFExNotesToPlane.c )
  2. pt_userguide ( UgSmtExtendWallCreate.c )
  3. pt_userguide ( UgSmtFlatWallCreate.c )
  4. pt_userguide ( UgSmtFlgWallCreate.c )