All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATTPSInterfaces Interface CATITPSNoa

System.IUnknown
  |
  +---CATITPSNoa
 

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


interface CATITPSNoa

Interface for the TPS Noa object.


Method Index


o GetFlagText(wchar_t**)
Retrieves Flag Text.
o GetNoaType(wchar_t**)
Retrieves Type of Noa.
o GetText(wchar_t**)
Retrieves Text Representation.
o GetURL(int,wchar_t**)
Retrieves url.
o GetUrlListSize(int*)
Retrieves the number of urls.
o SetFlagText(wchar_t*)
Sets Flag Text.
o SetNoaType(wchar_t*)
Sets Type of Noa.
o SetText(wchar_t*)
Sets Text Representation.
o SetURL(wchar_t*)
Set a link to file or URL.

Methods


o GetFlagText
public virtual HRESULT GetFlagText(wchar_t** opText) const = 0
Retrieves Flag Text.
Parameters:
opText
Flag Text
Returns:
S_OK if succeded (opText must be deleted).
o GetNoaType
public virtual HRESULT GetNoaType(wchar_t** opNoaType) const = 0
Retrieves Type of Noa.
Parameters:
opNoaType
Kind of Noa.
Returns:
S_OK if succeded (opNoaType must be deleted).
o GetText
public virtual HRESULT GetText(wchar_t** opText) const = 0
Retrieves Text Representation.
Parameters:
opText
Returned text for graphical representation.
Returns:
S_OK if succeded (opText must be deleted).
o GetURL
public virtual HRESULT GetURL( const int iIndex,
wchar_t** opUrl)const = 0
Retrieves url.
Parameters:
iIndex
Index of url.
opUrl
url
Returns:
S_OK if succeded (opUrl must be deleted).
o GetUrlListSize
public virtual HRESULT GetUrlListSize(int* oNumber)const = 0
Retrieves the number of urls.
Parameters:
oNumber
the size of url list.
o SetFlagText
public virtual HRESULT SetFlagText( const wchar_t* ipText) = 0
Sets Flag Text.
Parameters:
ipText
Flag Text
o SetNoaType
public virtual HRESULT SetNoaType( const wchar_t* ipNoaType) = 0
Sets Type of Noa.
Parameters:
ipNoaType
Kind of Noa, which will serve for filtering.
o SetText
public virtual HRESULT SetText( const wchar_t* ipText) = 0
Sets Text Representation.
Parameters:
ipText
Text for graphical representation.
o SetURL
public virtual HRESULT SetURL( const wchar_t* pUrl)const = 0
Set a link to file or URL.
Parameters:
pUrl
The url or file link to set.
Returns:
S_OK if succeded.

This object is included in the file: CATITPSNoa.h

Copyright © 2003, Dassault Systèmes. All rights reserved.