Create Reference Symbol

Function Name: Create Reference Symbol

Definition

Creates a reference symbol to be used for forward-referencing objects.

This reference symbol can be used in SE_AddSymbolicComponent() and/or SE_AddSymbolicAssociate() either before or after being assigned to an object with SE_AssignReferenceSymbolToObject(). This allows a user to create an object's relationships without keeping the object in memory for a prolonged period of time.

Returns

SE_SUCCESS - and a handle to the new reference symbol is copied into *ref_symbol_out_ptr, if valid parameters were passed in and all operations succeeded.

SE_NULL_REQUIRED_PARAMETER - and no changes are made, if ref_symbol_out_ptr is NULL.

SE_OUT_OF_MEMORY - and *ref_symbol_out_ptr is set to NULL, if the reference symbol could not be allocated.

SE_FAILURE - and *ref_symbol_out_ptr is set to NULL, if the API implementation specified does not provide this function in its shared library, and dynamic binding is specified at compile time.

Prototype

extern SE_STATUS_CODE_ENUM
SE_CreateReferenceSymbol
(
const	char		implementation_identifier[],	(notes)
	SE_REFERENCE_SYMBOL	*	ref_symbol_out_ptr	(notes)
);

Parameters Notes

implementation_identifier

 identifies the API implementation
    to use when creating this reference symbol.  If the specified API can't
    create the reference symbol, then the API will return a status code
    indicating why it could not be created.  If implementation_identifier is
    NULL, then the API implementation to be used must be statically bound at
    compile time.

    See also SE_GetImplementationIdentifier().

ref_symbol_out_ptr

 pointer to a variable, passed in by the user,
    in which a handle to the reference symbol being created will be placed.

Prev: Create Object. Next: Create Reference Symbol From String. Up:Index.