ProductStructureUseItf Interface CATIPrdPublication

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

interface CATIPrdPublication

Interface to manage PLM Product Publication.

Role: A Publication is a PLM object aggregated by a PLM Product Reference or a PLM Product Representation Reference.
It is defined by the following characteristics:

• An Owner, the PLM Product Object aggregating it.
• A Name which should conform to the following rules:
  • It must be unique within the context of its owner.
  • It must not be empty nor include following characters: '!' , ':' , '<' , '>'
  • It must not be ended by a blank: for example "Invalid_Pub_Name " is forbidden.
• A Pointed (Published) Object which can be:
  • An object in a context referencing the object pointed by the Publication.
    An Object in a context means an occurrence or a representation occurrence which can be seen as a path of instances and/or a representation instance.
    The exposed object can be a geometry (line, point, ...), a parameter (formula, dimension, ...) or another Publication.
  • Or empty.

Method Index

o GetName(CATUnicodeString&)

Retrieves the Publication name.

o GetOwner(CATBaseUnknown_var&)

Retrieves the Publication owner.

o GetPointed(CATOmbObjectInContext*&,CATBoolean)

Retrieves the pointed object in context.

o SetPointed(CATOmbObjectInContext*)

Sets the pointed object in context.

Methods

Retrieves the Publication name.
Role: This method retrieves the Publication name which is always valuated.

Parameters:

oPublicationName

The Publication name.
It is NULL if the method fails.

Returns:

An HRESULT value.
Legal values:

• S_OK: The Publication name was successfully retrieved.
• E_FAIL : The Publication name search failed.

Retrieves the Publication owner.
Role: This method retrieves the object aggregating the Publication. This owner adheres to the interface

Parameters:

ohOwner

The Publication owner.
It should not be valuated before the call.

Returns:

An HRESULT value.
Legal values:

• S_OK: The Publication owner was successfully retrieved.
• E_INVALIDARG: The output ohOwner parameter is already valuated before the call.
• E_FAIL: The Publication owner search failed.

Retrieves the pointed object in context.
Role: This method retrieves the pointed object in product context. The context means the product information, like the path of instance and/or the rep instance to reach the pointed object.

Parameters:

oObjInCtx

The Publication pointed object.
It should not be valuated before the call.

Unfolded

FALSE, value by default, means the returned pointed object is not unfolded.
TRUE, if the publication points another Publication, the returned pointed object is unfolded.

Returns:

An HRESULT value.
Legal values:

• S_OK: The object pointed by the Publication was successfully retrieved.
• S_FALSE: The object pointed by the Publication is not valuated.
• E_INVALIDARG: The output parameter is already valuated before the call.
• E_FAIL: The Publication pointed object search failed.

Sets the pointed object in context.
Role: This method sets the Publication pointed object to a new one.
If the Publication already has a pointer object, the previous pointed object is replaced and will be automatically deleted at the end of the session.

Parameters:

iObjInCtx

The new Publication pointed object.

Returns:

An HRESULT value.
Legal values:

• S_OK: The new Publication pointed object was successfully set.
• E_FAIL: The Publication settings falied with the given information.
Using the global function CATGetLastError, you can analyze the returned CATError.
• ProductERR_2309:
The element can not be published : publications can only be created on references.
• ProductERR_2310:
The element can not be published : error while trying to set the publication to the selected target.

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