API browser of tarmedValidator100 COM module


/images/arrow_right.png ISearch::FindInclusion method
This method finds the first inclusion service for a base service.
 
PATCH
Due to the fact that certain services are for specific laws and/or gender the ISearch::FindInclusion method is patched to allow for a filtering of law and/or gender information in the aforementioned services. The patch is applied by using one of the specific code {"GetLawRestriction", "GetSexRestriction"}.
space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT FindInclusion( BSTR
BSTR
VARIANT_BOOL
bstrCode,
*pbstrInclusionCode,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[in] BSTR bstrCode Base service code.
 
Patch
The virtual codes "GetLawRestriction" or "GetSexRestriction" can be used to find law or gender dependent inclusion services.
[out] BSTR *pbstrInclusionCode Inclusion service code.
 
PATCH
  • by setting bstrCode="GetLawRestriction", pbstrInclusionCode includes a semicolon separated list of applicable laws. If there is no restriction, an empty string will be returned!!
     
  • by setting bstrCode="GetSexRestriction", pbstrInclusionCode includes a gender code, namely
    • empty string == no sex restriction
    • {0|enMale} == restricted to males only
    • {1|enFemale} == restricted to females only
[out, retval] VARIANT_BOOL *pbStatus Return status of the method
 
/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.