API browser of generalCreditResponse430 COM module


/images/arrow_right.png IGeneralCreditResponse::GetCreditRef method
Retrieves the optional credit_ref object reference parameters. This object reference is only defined if the credit type (GetCredit@creditType) is 'prologation' or 're-considersation'.

The credit_ref, 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 GetCreditRef( BSTR
DATE
long
VARIANT_BOOL
*pbstrRequestCreditID,
*pdRequestCreditDate,
*plRequestCreditTimestamp,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[out] BSTR *pbstrRequestCreditID 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.

[out] DATE *pdRequestCreditDate 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.

[out] long *plRequestCreditTimestamp 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.

[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.