API browser of generalCreditResponse430 COM module


/images/arrow_right.png IGeneralCreditResponse::GetFirstService method
Retrieves the first service record. This is an exact copy from the request supplemented by a response cost block (quantity, base amount, amount, remark). The response cost block is valid only for an accepted response whereas in the other cases it is undefined.

VARIANT_FALSE is returned if the end of the service list is reached.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetFirstService( BSTR
BSTR
BSTR
double
double
double
double
BSTR
double
double
double
double
BSTR
VARIANT_BOOL
*pbstrTariffType,
*pbstrCode,
*pbstrText,
*pdQuantityRequest,
*pdBaseAmountRequest,
*pdScaleFactorRequest,
*pdAmountRequest,
*pbstrRemarkRequest,
*pdQuantityResponse,
*pdBaseAmountResponse,
*pdScaleFactorResponse,
*pdAmountResponse,
*pbstrRemarkResponse,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[out] BSTR *pbstrTariffType The official tariff type as defined by Forum Datenaustausch
bstrTariffType might be empty if the service is not covered by a official tariff catalog
[out] BSTR *pbstrCode The service code as given by the used tariff catalog.
bstrCode might be empty if the service is not covered by an official tariff catalog.
[out] BSTR *pbstrText The service name is the official service name as given by the used tariff catalog. If it is not a
service in the narrow sense (not covered by an official tariff catalog) then it describes that service with best effort.
[out] double *pdQuantityRequest The floating point quantity defined by the request cost block.

Note that quantity changes the sign if the storno bit is set.

[out] double *pdBaseAmountRequest The base amount is the cost in CHF of one unit (service) including any VAT portion defined by the request cost block.

Note, that the base amount includes any VAT portion

[out] double *pdScaleFactorRequest The applied scale factor for the given service defined by the request cost block. In principle the scale factor is used for defining discounts or surchages. However, it can be used as well for defining cost fractions e.g. in a DRG service.
[out] double *pdAmountRequest The amount in CHF of the service supplied in 2-digit precision calculated as quantity*scale factor*base amount defined by the request cost block.

Note, that the base amount includes any VAT portion, therefore amount does as well. Furthermore, note as well that amount changes the sign if the storno bit is set.

[out] BSTR *pbstrRemarkRequest The optional remark for the given service defined by the request cost block.
[out] double *pdQuantityResponse The floating point quantity defined by the response cost block.

The quantity is valid for accepted responses only otherwise it is 0.

Note that quantity changes the sign if a storno request is produced.

[out] double *pdBaseAmountResponse The base amount is the cost in CHF of one unit (service) including any VAT portion defined by the response cost block.

The base amount is valid for accepted responses only otherwise it is 0.

Note, that the base amount includes any VAT portion

[out] double *pdScaleFactorResponse The applied scale factor for the given service defined by the response cost block. In principle the scale factor is used for defining discounts or surchages. However, it can be used as well for defining cost fractions e.g. in a DRG service.
[out] double *pdAmountResponse The amount in CHF of the service supplied in 2-digit precision calculated as quantity*scale factor*base amount defined by the response cost block.

Note, that the base amount includes any VAT portion, therefore amount does as well. Furthermore, note as well that amount changes the sign if the storno bit is set.

[out] BSTR *pbstrRemarkResponse The optional remark for the given service defined by the response cost block.

The remark is valid for accepted responses only otherwise it is empty.

[out, retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE the end of data is reached
 
/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.