All Frameworks  Class Hierarchy  This Framework  Next  Indexes

CATPlantShipModeler Class CATPspListServices

CATPspListServices
 

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


public class CATPspListServices

Tools to manage list of pointers.
Role: For creation and query of list of pointers.


Method Index


o CreateCATICStringList(CATICStringList**)
Create CATICStringList object for a list of character strings.
o CreateCATIStringList(CATIStringList**)
Create CATIStringList object for a list of NLS strings.
o CreateCATIUnknownList(CATIUnknownList**)
Create CATIUnknownList object for a list of IUnknown interface pointers.
o Locate(CATICStringList*,char*)
Locate a target string from a list of character string pointers.
o Locate(CATIStringList*,wchar_t*)
Locate a target string from a list of NLS string pointers.
o Locate(CATIUnknownList*,IUnknown*)
Locate a target IUnknown from a List of IUnknown interface pointers.

Methods


o CreateCATICStringList
public static HRESULT CreateCATICStringList(CATICStringList** oLCString)
Create CATICStringList object for a list of character strings.
Parameters:
oLCString
[out, IUnknown#Release] A list of character string pointers.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o CreateCATIStringList
public static HRESULT CreateCATIStringList(CATIStringList** oLString)
Create CATIStringList object for a list of NLS strings.
Parameters:
oLString
[out, IUnknown#Release] CATIStringList interface pointer. (Limit Use for NLS Strings ONLY).
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o CreateCATIUnknownList
public static HRESULT CreateCATIUnknownList(CATIUnknownList** oLUnknown)
Create CATIUnknownList object for a list of IUnknown interface pointers.
Parameters:
oLUnknown
[out, IUnknown#Release] A list of interface pointers.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o Locate
public static int Locate(CATICStringList* iLCString,
const char* iTarget)
Locate a target string from a list of character string pointers.
Parameters:
iLCString
A list of character string pointers.
iTarget
The character string pointer to be located.
Returns:
integer value. The position of the target in the list starting at 0.
Legal values:
Less than 0
Not found
Greater than or equal to 0
found
o Locate
public static int Locate(CATIStringList* iLString,
const wchar_t* iTarget)
Locate a target string from a list of NLS string pointers.
Parameters:
iLString
CATIStringList pointer.
iTarget
wchar_t character string to look for in iLString.
Returns:
integer value. If string is found it gives the location index starting at 0.
Legal values:
Less than 0
Not found
Greater than or equal to 0
found
o Locate
public static int Locate(CATIUnknownList* iLUnknown,
IUnknown* iTargetUnknown)
Locate a target IUnknown from a List of IUnknown interface pointers.
Parameters:
iLUnknown
A list of IUnknown pointers.
iTargetUnknown
The IUnknown interface pointer to be located.
Returns:
integer value. The position of the target in the list starting at 0.
Legal values:
Less than 0
Not found
Greater than or equal to 0
found

This object is included in the file: CATPspListServices.h
If needed, your Imakefile.mk should include the module: CATPspUtilities

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