CATAnnotationUseItf Interface CATIAnnLinkDescriptor

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIAnnLinkDescriptor

Interface to manage a link to be hold by a text.
see Example: 

  CATIAnnLinkDescriptor *pLinkDescriptor = CATIAnnLinkDescriptor::CreateInstance();
  if(pLinkDescriptor)
  {
    ...
    pLinkDescriptor->Release(), pLinkDescriptor = NULL;
  }

Method Index


o CreateInstance()
Creates an instance implementing CATIAnnLinkDescriptor.
o SetLinkToAttribute(CATBaseUnknown*,CATAttributeInfos&,CATBoolean)
o SetLinkToParameter(CATBaseUnknown*,CATBoolean)
Asks the descriptor for a link to a parameter.
o SetLinkToTypeAttribute(CATBaseUnknown*,CATIType*,CATAttributeInfos&,CATBoolean)
Asks the descriptor for a link to an attribute of a PLM entity or a feature.

Methods


o CreateInstance
public static CreateInstance()
Creates an instance implementing CATIAnnLinkDescriptor.
Returns:
CATIAnnLinkDescriptor [CATBaseUnknown#Release] The created instance or NULL if an error occurred.
o SetLinkToAttribute
public virtual SetLinkToAttribute( ipAttributeOwner,
const iAttributeInfos,
iAssociativity)
Deprecated:
R215. Use instead.
o SetLinkToParameter
public virtual SetLinkToParameter( ipParameter,
iAssociativity)
Asks the descriptor for a link to a parameter. If iAssociativity is TRUE although the attribute cannot be linked associatively then the method will return S_FALSE.
Parameters:
ipParameter
[in] A
describing the parameter to be linked toward a context or not.
iAssociativity
[in] The asked associativity:
  • TRUE The descriptor is asked for associative link.
  • FALSE The descriptor is asked for datum link.
Returns:
HRESULT Error code:
  • S_OK The function has being executed successfully.
  • S_FALSE The function has being executed successfully but the resolution will be non associative.
  • E_UNEXPECTED An unexpected error occurred during the execution of the function.
  • E_INVALIDARG At least one argument was not valid (see preconditions).
  • E_FAIL The given arguments were not compliant for describing a link.
o SetLinkToTypeAttribute
public virtual SetLinkToTypeAttribute( ipAttributeOwner,
ipType,
const iAttributeInfos,
iAssociativity)
Asks the descriptor for a link to an attribute of a PLM entity or a feature. If ipAttributeOwner does not support ipType then the method will fail and return E_FAIL. If iAttributeInfos does not describe an attribute hold by ipAttributeOwner then the method will fail and return E_FAIL. If iAssociativity is TRUE whereas the attribute cannot be linked associatively then the method will return S_FALSE.
Parameters:
ipAttributeOwner
[in] A
describing the owner of the attribute to be linked toward a context or not.
ipType
[in] The
of the attribute belongs to.
iAttributeInfos
[in] The
of the attibute to be linked.
iAssociativity
[in] The asked associativity:
  • TRUE The descriptor is asked for associative resolution.
  • FALSE The descriptor is asked for non associative resolution.
Returns:
HRESULT Error code:
  • S_OK The function has being executed successfully.
  • S_FALSE The function has being executed successfully but the resolution will be non associative.
  • E_UNEXPECTED An unexpected error occurred during the execution of the function.
  • E_INVALIDARG At least one argument was not valid (see preconditions).
  • E_FAIL The given arguments were not compliant for describing a link.
This object is included in the file: CATIAnnLinkDescriptor.h
If needed, your Imakefile.mk should include the module: CATAnnotationUseItf

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.