LoadEntity

Description

Returns the specified record with latest database values.

This method is the same as GetEntity, except that it ensures that you are using the latest values in the database.

Returns a different error message if record is hidden from the user vs record doesn't exist

Syntax

VBScript

session.LoadEntity(entity_def_name, display_name) 

Perl

$session->LoadEntity(entity_def_name, display_name); 
Identifier
Description
session
The Session object that represents the current database-access session.
entity_def_name
A String that identifies the name of the record type to which the record belongs.
display_name
A String containing the display name of the record
Return value
An Entity Object corresponding to the requested record.

Returns an Entity object or one of the following error messages:

1 = AD_ENTITY_NOT_FOUND - Does not exist

3 = AD_ENTITY_HIDDEN - Exists but hidden from current user

Examples

VBScript

set entityObj = session.LoadEntity("defect", "Sampl00000001"); 

Perl

$entityObj = $session->LoadEntity("defect", "Sampl00000001");



Feedback