adTempus API
ArcanaDevelopment.adTempus.Client Namespace / ICustomObject Interface / TryGetCustomObjectDefinition Method
On success, contains the object definition


In This Topic
    TryGetCustomObjectDefinition Method (ICustomObject)
    In This Topic
    Attempts to get the custom data definition for the custom object.
    Syntax
    'Declaration
 

    <ContractAnnotationAttribute("true=>objectDefinition:notnull; false=>objectDefinition:null")>
Function TryGetCustomObjectDefinition( _
   ByRef objectDefinition As ICustomObjectSettings _
) As Boolean
    [ContractAnnotation("true=>objectDefinition:notnull; false=>objectDefinition:null")]
bool TryGetCustomObjectDefinition( 
   out ICustomObjectSettings objectDefinition
)
    [ContractAnnotation("true=>objectDefinition:notnull; false=>objectDefinition:null")]
bool TryGetCustomObjectDefinition( 
   [Out] ICustomObjectSettings^ objectDefinition
)

    Parameters

    objectDefinition
    On success, contains the object definition

    Return Value

    True if the definition was successfully returned, False otherwise.
    Remarks
    The data definition is stored by adTempus in serialized form. When you request it using by reading the CustomObjectDefinition property, adTempus loads the add-in defined for the object, deserializes the data, and returns the add-in object. If the add-in cannot be loaded, or the data cannot be deserialized, this method returns False.
    See Also

    Reference

    ICustomObject Interface
    ICustomObject Members
    CustomObjectDefinition Property