This function is called by UNICOM Intelligence Interviewer - Server at authentication. For details about when authentication occurs, see When does authentication take place?.

The function in this example calls the Queues.AuthenticateSampleRec method, which looks in the sample table for a sample record with matching authentication fields. If a matching record is found, the function sets the return value to SUCCESS and returns the sample record (SampleRec object). Any sample fields passed in the SampleFields input parameter overwrite the corresponding sample fields on the returned sample record. If a matching record is not found, the function sets the return value to FAILURE and returns a SampleRec object with a value of Nothing. The function does not explicitly need to set the SampleRec object to Nothing because the Queues.AuthenticateSampleRec Queues.AuthenticateSampleRec method automatically does this when a matching record is not found.

The function in this example calls the Queues.AuthenticateSampleRec method like the previous example. However, if a matching record is found, the function performs an additional test. If the matching sample record is in the COMPLETED queue, the function sets the return code to REJECT and the SampleRec object to Nothing.

For more information about Queues.AuthenticateSampleRec, see Sample Management Object model.