MachiningUseItf Interface DELIMfgPPWord

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

interface DELIMfgPPWord

Interface representing PP Words.

Method Index

o Append(CATString&): Adds a line of PP Words at the end of the record.
o GetNumberOfLines(int&): Gives the number of lines of the record.
o GetPPWord(int,CATUnicodeString&): Gives the PPWord relating to a range number
o GetPPWordList(CATListOfCATUnicodeString&): Gives all the PPWord lines of the record
o RemoveAll(): Remove the all the records.
o RemovePosition(int): Remove the PPWord relating to a range number

Methods

o Append

public virtual Append( const iCommandName)

Adds a line of PP Words at the end of the record.

Parameters:

iCommandName: The PPWord string to add

Returns:

Return code.
Legal values:

S_OK : succeeded
other case : an error occured

o GetNumberOfLines

public virtual GetNumberOfLines( oNumberOfLines)

Gives the number of lines of the record.

Parameters:

oNumberOfLines: Number of lines of the record.

Returns:

Return code.
Legal values:

S_OK : succeeded
other case : an error occured

o GetPPWord

public virtual GetPPWord(		`iRangeNumber`,
		`oPPWord`)

Gives the PPWord relating to a range number

Parameters:

iRangeNumber: Range number of the line to read inside the record.
oPPWord: The PPWord string.

Returns:

The return code
Legal values:

S_OK : succeeded
other case : an error occured

o GetPPWordList

public virtual GetPPWordList( oPPWordList)

Gives all the PPWord lines of the record

Parameters:

oPPWordList: The PPWord list of strings.

Returns:

The return code
Legal values:

S_OK : succeeded
other case : an error occured

o RemoveAll

public virtual RemoveAll(

)

Remove the all the records.

Returns:

The return code
Legal values:

S_OK : succeeded
other case : an error occured

o RemovePosition

public virtual RemovePosition( iRangeNumber)

Remove the PPWord relating to a range number

Parameters:

iRangeNumber: Range number of the line to remove inside the record.

Returns:

The return code
Legal values:

S_OK : succeeded
other case : an error occured

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