All Frameworks Class Hierarchy This Framework Indexes
CATTPSInterfaces Interface CATITPSFlagNote
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATITPSFlagNote
Interface for the TPS Flag Note object.
Method Index
- o
GetFlagText(wchar_t**)
- Retrieves flag text.
- o
GetText(wchar_t**)
- Retrieves text.
- o
GetURL(int,wchar_t**)
- Retrieves URL.
- o
GetUrlListSize(int*)
- Retrieves the number of URLs.
- o
RemoveURL(int)
- Deletes an URL.
- o
SetFlagText(wchar_t*)
- Sets flag text.
- o
SetText(wchar_t*)
- Sets text.
- o
SetURL(wchar_t*,int)
- Sets or modifies a link to file or URL.
Methods
o GetFlagText
| public virtual GetFlagText( | | opText) |
-
Retrieves flag text.
o GetText
| public virtual GetText( | | opText) |
-
Retrieves text.
o GetURL
| public virtual GetURL( | const | iIndex, |
| | opUrl) |
-
Retrieves URL.
- Parameters:
-
- iIndex
- Index of URL.
- opUrl
- URL
- Returns:
- S_OK if succeded (opUrl must be deleted).
o GetUrlListSize
| public virtual GetUrlListSize( | | oNumber) |
-
Retrieves the number of URLs.
- Parameters:
-
- oNumber
- the size of URL list.
o RemoveURL
| public virtual RemoveURL( | const | iIndex) |
-
Deletes an URL.
- Parameters:
-
- iIndex
- Index of URL to remove.
- Returns:
- S_OK if succeded.
o SetFlagText
| public virtual SetFlagText( | const | ipText) |
-
Sets flag text.
o SetText
| public virtual SetText( | const | ipText) |
-
Sets text.
o SetURL
| public virtual SetURL( | const | pUrl, |
| const | iIndex | = -1 ) |
-
Sets or modifies a link to file or URL.
- Parameters:
-
- pUrl
- The url or file link to set.
- iIndex
- index of the URL to modify.
if the iIndex is not defined, the URL is added to the FlagNote.
- Returns:
- S_OK if succeded.
This object is included in the file: CATITPSFlagNote.h