ObjectModelerBase CATOmbLinkStatusServices

Usage: you must use this class as is. You should never derive it.

public class CATOmbLinkStatusServices

Class to interpret the return code of link resolution methods.
Role: This class provides a static method to interpret the return code of link resolution methods.

Method Index


o GetLinkStatusFromRc(HRESULT,LinkResolutionStatus&)
Retrieves the link resolution status from the rc.

Enumerated Type Index


o LinkResolutionStatus
Link status corresponding to the return code of a link resolution.

Methods


o GetLinkStatusFromRc
public static GetLinkStatusFromRc( irc,
oStatus)
Retrieves the link resolution status from the rc.
Parameters:
irc
The return code given by the link resolution method.
oStatus
the corresponding link status.
Returns:
An HRESULT value:
S_OK
irc is a known link resolution return code.
E_INVALIDARG
otherwise.

Enumerated Types


o LinkResolutionStatus 
enum LinkResolutionStatus {
  Target_Found,
  Component_NotInSession,
  Relation_Broken,
  Link_Broken,
  Target_NotInSession,
  InvalidLink
}
Link status corresponding to the return code of a link resolution.
Parameters:
Target_Found
The link resolution succeeded
Component_NotInSession
The pointed component is not in session.
Relation_Broken
The relational part of the link corresponds to a destroyed/inexistant component
Link_Broken
The pointed component is in session The private path of the link corresponds to a destroyed/inexistant target
Target_NotInSession
The pointed component is in session but not the target inside the component.
InvalidLink
The link is corrupted due to an unsupported format. This link will never be solved.
This object is included in the file: CATOmbLinkStatusServices.h
If needed, your Imakefile.mk should include the module: CATObjectModelerBase

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