API browser of tardocValidator100 COM module


/images/arrow_right.png ISearch::GetSexRestriction method space
Returns the gender-specific restriction, if any, for the current context or service.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/ISearch/GetSexRestriction
[JSON input data] pISearch: longValue,    //interface address
[JSON result data] plSexRestriction:
pbStatus:
longValue,
booleanValue
 
[HTTP result status] 200 Return status 200 signals a successful method call
204 Return status 204 (noContent) signals that the end of an iteration is reached
>= 400 Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetSexRestriction( long
VARIANT_BOOL
*plSexRestriction,
*pbStatus);
[C/C++ return value] S_OK This value is returned if the function call was successful.
S_FALSE This value is returned if the end of an iteration is reached
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.
space
/images/arrow_right.png Calling argument description
[out] long *plSexRestriction Numeric value indicating the restriction.
- `0` = Male only (`enMale`)
- `1` = Female only (`enFemale`)
- `2` = Applicable to both sexes
[out,retval] VARIANT_BOOL *pbStatus VARIANT_TRUE if a restriction was found or evaluated successfully; VARIANT_FALSE otherwise.
space