All Frameworks Class Hierarchy This Framework Indexes
VPMInterfaces Interface VPMIIdentifierGeneratorMgr
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface VPMIIdentifierGeneratorMgr
Method Index
- o
end()
- free the resources.
- o
getIdentifierSuffix(CATUnicodeString&,int&,CATUnicodeString&)
- For a given (Prefix,separator) , return an unique int identifier.
- o
getIdentifier(CATUnicodeString&,CATUnicodeString&,int,int)
- get an identifier guaranteed to be unique.
- o
getIdentifier(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,int,int)
- get an identifier guaranteed to be unique.
- o
getIdentifier_pad(CATUnicodeString&,CATUnicodeString&,int,int)
- get an identifier guaranteed to be unique.
- o
getNConsecutiveIdentifierSuffix(CATUnicodeString&,int,int&,CATUnicodeString&)
- For a given (prefix, separator) , return N Consecutive int Identifiers.
- o
getNConsecutiveIdentifier(CATUnicodeString&,int,CATListOfCATUnicodeString&,int,int)
- get N consecutive identifiers guaranteed to be unique.
- o
getNConsecutiveIdentifier(CATUnicodeString&,CATUnicodeString&,int,CATListOfCATUnicodeString&,int,int)
- get N consecutive identifiers guaranteed to be unique.
- o
getNConsecutiveIdentifier_pad(CATUnicodeString&,int,CATListOfCATUnicodeString&,int,int)
- get N consecutive identifiers guaranteed to be unique.
- o
init(int)
- initialize the IdentifierGenerator.
- o
setPrefixValue(CATUnicodeString&,int,int,int)
- setPrefix.
- o
setPrefixValue(CATUnicodeString&,CATUnicodeString&,int,int,int,int)
- setPrefix.
- o
setPrefixValue_pad(CATUnicodeString&,int,int,int,int)
- setPrefix_pad.
Methods
o end
-
free the resources.
- Returns:
- An HRESULT value.
Legal values
- S_OK
- the initial value is set
- E_FAIL
- system failure.
o getIdentifierSuffix
| public virtual getIdentifierSuffix( | const | iPrefix, |
| | oIdentifier, |
| const | iSeparator) |
-
For a given (Prefix,separator) , return an unique int identifier.
the identifier returned is an int.
- Parameters:
-
- iPrefix
- [in] prefixes the identifier.
- oIdentifier
- [out] the suffixe value returned.
- iSeparator
- [in] character separating the Prefix from the integer counter.
string size = 1. [0..9] are forbidden values.
- Returns:
- An HRESULT value.
Legal values
- S_OK
- identifier generated successfully
- S_FALSE
- illegal parameters or cannot generate a greater identifier
- E_FAIL
- system failure.
o getIdentifier
| public virtual getIdentifier( | const | iPrefix, |
| | oIdentifier, |
| const | iMaxSize | =230, |
| const | iForce | =0 ) |
-
get an identifier guaranteed to be unique.
this identifier is the concatenation of a string, a separator ":",
and a integer.
the separator is ":".
- Parameters:
-
- iPrefix
- [in] prefixes the identifier. his Size cannot be greater than xxx.
- oIdentifier
- [out] the identifier generated
- iMaxSize
- [in] the maximum size in byte of the identifier.
- iForce
- [in] iForce = 0 : if the size of oIdentifier is greater than iMaxSize
then return S_FALSE and nothing is done.
iForce = 1 : deprecated. return S_FALSE.
- Returns:
- An HRESULT value.
Legal values
- S_OK
- identifier generated successfully
- S_FALSE
- illegal parameters or cannot generate a greater identifier
- E_FAIL
- system failure.
o getIdentifier
| public virtual getIdentifier( | const | iPrefix, |
| const | iSeparator, |
| | oIdentifier, |
| const | iPadding, |
| const | iMaxSize) |
-
get an identifier guaranteed to be unique.
this identifier is the concatenation of a string, a separator ,
and an integer.
- Parameters:
-
- iPrefix
- [in] prefixes the identifier. his Size cannot be greater than xxx.
- iSeparator
- [in] character separating the Prefix from the integer counter.
string size = 1. [0..9] are forbidden values.
- oIdentifier
- [out] the identifier generated
- iPadding
- [in] pad (left side ) the integer part with 0.
iPadding > 0:the size in char of the integer part is equal to iPadding.
iPadding =-1:no pad done.
- iMaxSize
- [in] the maximum size in byte of the identifier.
- iForce
- [in] iForce = 0 : if the size of oIdentifier is greater than iMaxSize
then return S_FALSE and nothing is done.
iForce = 1 : deprecated . return S_FALSE.
- Returns:
- An HRESULT value.
Legal values
- S_OK
- identifier generated successfully
- S_FALSE
- illegal parameters or cannot generate a greater identifier
- E_FAIL
- system failure.
o getIdentifier_pad
| public virtual getIdentifier_pad( | const | iPrefix, |
| | oIdentifier, |
| const | iPadding, |
| const | iMaxSize) |
-
get an identifier guaranteed to be unique.
this identifier is the concatenation of a string, a separator ,
and an integer.
- Parameters:
-
- iPrefix
- [in] prefixes the identifier. his Size cannot be greater than xxx.
- oIdentifier
- [out] the identifier generated
- iPadding
- [in] pad (left side ) the integer part with 0.
iPadding > 0:the size in char of the integer part is equal to iPadding.
iPadding =-1:no pad done.
- iMaxSize
- [in] the maximum size in byte of the identifier.
- Returns:
- An HRESULT value.
Legal values
- S_OK
- identifier generated successfully
- S_FALSE
- illegal parameters or cannot generate a greater identifier
- E_FAIL
- system failure.
o getNConsecutiveIdentifierSuffix
| public virtual getNConsecutiveIdentifierSuffix( | const | iPrefix, |
| const | iNbIdentifiers, |
| | oIdentifiers, |
| const | iSeparator | =":") |
-
For a given (prefix, separator) , return N Consecutive int Identifiers.
- Parameters:
-
- iPrefix
- [in] prefixes the identifier.
- iNbIdentifiers
- [in] the number of identifiers to be generated.
- oIdentifier
- [out] The first identifier.
- iSeparator
- [in] character separating the Prefix from the integer counter.
string size = 1. [0..9] are forbidden values.
- Returns:
- An HRESULT value.
Legal values
- S_OK
- identifiers generated successfully
- S_FALSE
- illegal parameters or cannot generate an identifier
- E_FAIL
- system failure.
o getNConsecutiveIdentifier
| public virtual getNConsecutiveIdentifier( | const | cPrefix, |
| const | iNbSuffix, |
| | olIdentifiers, |
| const | iMaxSize | =230, |
| const | iForce | =0 ) |
-
get N consecutive identifiers guaranteed to be unique.
these identifiers are the concatenation of a string, a separator ":",
and a integer.
the separator is ":"
- Parameters:
-
- iPrefix
- [in] prefixes the identifier. his Size cannot be greater than xxx.
- iNbIdentifiers
- [in] the number of identifiers to be generated.
- olIdentifiers
- [out] a list containing the identifiers returned.
- iMaxSize
- [in] the maximum size in byte of the identifier.
- iForce
- [in] iForce = 0 : if the size of oIdentifier is greater than iMaxSize
then return S_FALSE and nothing is done.
iForce = 1 : deprecated . return S_FALSE.
- Returns:
- An HRESULT value.
Legal values
- S_OK
- identifiers generated successfully
- S_FALSE
- illegal parameters or cannot generate an identifier
- E_FAIL
- system failure.
o getNConsecutiveIdentifier
| public virtual getNConsecutiveIdentifier( | const | iPrefix, |
| const | iSeparator, |
| const | iNbIdentifiers, |
| | olIdentifiers, |
| const | iPadding, |
| const | iMaxSize) |
-
get N consecutive identifiers guaranteed to be unique.
these identifiers are the concatenation of a string, a separator ,
and an integer.
- Parameters:
-
- iPrefix
- [in] prefixes the identifier. his Size cannot be greater than xxx.
- iSeparator
- [in] character separating the Prefix from the integer counter.
string size = 1. [0..9] are forbidden values.
- iNbIdentifiers
- [in] the number of identifiers to be generated.
- olIdentifiers
- [out] a list containing the identifiers returned.
- iPadding
- [in] pad (left side ) the integer part with 0.
iPadding > 0:the size in char of the integer part is equal to iPadding.
iPadding =-1:no pad done.
- iMaxSize
- [in] the maximum size in byte of the identifier.
- Returns:
- An HRESULT value.
Legal values
- S_OK
- identifiers generated successfully
- S_FALSE
- illegal parameters or cannot generate an identifier
- E_FAIL
- system failure.
o getNConsecutiveIdentifier_pad
| public virtual getNConsecutiveIdentifier_pad( | const | iPrefix, |
| const | iNbIdentifiers, |
| | olIdentifiers, |
| const | iPadding, |
| const | iMaxSize) |
-
get N consecutive identifiers guaranteed to be unique.
these identifiers are the concatenation of a string, a separator ,
and an integer.
- Parameters:
-
- iPrefix
- [in] prefixes the identifier. his Size cannot be greater than xxx.
- iNbIdentifiers
- [in] the number of identifiers to be generated.
- olIdentifiers
- [out] a list containing the identifiers returned.
- iPadding
- [in] pad (left side ) the integer part with 0.
iPadding > 0:the size in char of the integer part is equal to iPadding.
iPadding =-1:no pad done.
- iMaxSize
- [in] the maximum size in byte of the identifier.
- Returns:
- An HRESULT value.
Legal values
- S_OK
- identifiers generated successfully
- S_FALSE
- illegal parameters or cannot generate an identifier
- E_FAIL
- system failure.
o init
| public virtual init( | | iMode | = 0) |
-
initialize the IdentifierGenerator.called by the VPMSession.
- Parameters:
-
- iMode
- [in] not used.
- Returns:
- An HRESULT value.
Legal values
- S_OK
- initialization is successful
- E_FAIL
- failure. (Database connection or settings pb)
o setPrefixValue
| public virtual setPrefixValue( | const | iPrefix, |
| const | iValue | =0 , |
| const | iMaxSize | =230, |
| const | iForce | =0 ) |
-
setPrefix. used to set the initial value for a prefix.
the separator is supposed to be ":".
- Parameters:
-
- iPrefix
- [in] the prefix of the identifier to set.
- iValue
- [in] the value for the next given suffixe.
- iMaxSize
- [in] size overflow.
- iForce
- [in] iForce=0 : if the current value for iPrefix is greater
than iValue return S_FALSE.
if there is no current value or the current value is less
than iValue the next given value will be iValue.
iForce=1 : set the value without controls
- Returns:
- An HRESULT value.
Legal values
- S_OK
- the initial value is set
- S_FALSE
- illegal parameters or cannot set the initial value
- E_FAIL
- system failure.
o setPrefixValue
| public virtual setPrefixValue( | const | iPrefix, |
| const | iSeparator, |
| const | iValue, |
| const | iPadding, |
| const | iMaxSize, |
| const | iForce) |
-
setPrefix. used to set the initial value for a prefix.
- Parameters:
-
- iPrefix
- [in] the prefix of the identifier to set.
- iSeparator
- [in] character separating the Prefix from the integer counter.
string size = 1. [0..9] are forbidden values.
- iValue
- [in] the value for the next given suffixe.
- iPadding
- [in] pad (left side ) the integer part with 0.
iPadding > 0:the size in char of the integer part is equal to iPadding.
iPadding =-1:no pad done.
- iMaxSize
- [in] size overflow.
- iForce
- [in] iForce=0 : if the current value for iPrefix is greater
than iValue return S_FALSE.
if there is no current value or the current value is less
than iValue the next given value will be iValue.
iForce=1 : set the value without controls
- Returns:
- An HRESULT value.
Legal values
- S_OK
- the initial value is set
- S_FALSE
- illegal parameters or cannot set the initial value
- E_FAIL
- system failure.
o setPrefixValue_pad
| public virtual setPrefixValue_pad( | const | iPrefix, |
| const | iValue, |
| const | iPadding, |
| const | iMaxSize, |
| const | iForce) |
-
setPrefix_pad. used to set the initial value for a prefix.
- Parameters:
-
- iPrefix
- [in] the prefix of the identifier to set.
- iValue
- [in] the value for the next given suffixe.
- iPadding
- [in] pad (left side ) the integer part with 0.
iPadding > 0:the size in char of the integer part is equal to iPadding.
iPadding =-1:no pad done.
- iMaxSize
- [in] size overflow.
- iForce
- [in] iForce=0 : if the current value for iPrefix is greater
than iValue return S_FALSE.
if there is no current value or the current value is less
than iValue the next given value will be iValue.
iForce=1 : set the value without controls
- Returns:
- An HRESULT value.
Legal values
- S_OK
- the initial value is set
- S_FALSE
- illegal parameters or cannot set the initial value
- E_FAIL
- system failure.
This object is included in the file: VPMIIdentifierGeneratorMgr.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces