API browser of generalCreditRequest430 COM module


/images/arrow_right.png IGeneralCreditRequest::SetCredit method
Sets the credit object reference.

The credit_ref (if supplied in the request) and credit object references form a object reference chain (credit_ref -> credit) with the credit as topmost object reference. The page "object reference" provides an in-depth description of the concepts of "object reference", "object reference chain", and "topmost object reference".

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT SetCredit( CreditType
BSTR
DATE
long
YesNoType
VARIANT_BOOL
eCreditType,
bstrRequestCreditID,
dRequestCreditDate,
lRequestCreditTimestamp,
eIsCostEstimate,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[in] CreditType eCreditType The type of credit that is generated. If the credit type is not "new" than a credit_ref object must be defined for the "older" reference object.
[in] BSTR bstrRequestCreditID The request ID is the main software's identification of the credit ("Kostengutsprachenummer").

This is one of 3 identifiers that form the credit object reference.

[in] DATE dRequestCreditDate The request date is the main software's date of the credit request ("Kostengutsprachedatum").

This is one of 3 identifiers that form the credit object reference.

[in] long lRequestCreditTimestamp This is a UNIX timestamp defined at the moment of the credit's infoset generation.

This is one of 3 identifiers that form the credit object reference.

[in] YesNoType eIsCostEstimate Boolean value that defines the credit as "cost estimate" instead of "credit".

From a semantical point of view cost estimates ("Kostenvoranschlag") and credits ("Kostengutsprache") are the same. It is more of a legal question as 'cost estimate' has a narrower cost interval than a credit. If you don't know what to set then check with the cost bearer.

[out, retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred and GetAbortInfo should be called to retrieve the error string.
 
/images/arrow_right.png C/C++ return value
S_OK This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE.
S_FALSE This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE.
E_name This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions.