kDynamicLib.h

Go to the documentation of this file.

/** 
 * @file    kDynamicLib.h
 * @brief   Declares the kDynamicLib class. 
 *
 * @internal
 * Copyright (C) 2013-2014 by LMI Technologies Inc.
 * Licensed under the MIT License.
 * Redistributed files must retain the above copyright notice.
 */
#ifndef K_API_DYNAMIC_LIB_H
#define K_API_DYNAMIC_LIB_H

#include <kApi/kApiDef.h>

kBeginHeader()

/**
 * @class   kDynamicLib
 * @extends kObject
 * @ingroup kApi-Utils
 * @brief   Represents a dynamically loaded library.
 * 
 * This class relies on OS support for dynamic loading, and is only available on platforms that 
 * provide underlying support.
 */
//typedef kObject kDynamicLib;             --forward-declared in kApiDef.x.h 

/** 
 * Constructs a kDynamicLib object.
 * 
 * @public              @memberof kDynamicLib
 * @param   library     Destination for the constructed object handle. 
 * @param   path        Path to the dynamic library. 
 * @param   allocator   Memory allocator (or kNULL for default). 
 * @return              Operation status. 
 */
kFx(kStatus) kDynamicLib_Construct(kDynamicLib* library, const kChar* path, kAlloc allocator);

/** 
 * Resolves a function pointer by name from the dynamic library. 
 *
 * @public              @memberof kDynamicLib
 * @param   library     Dynamic library object. 
 * @param   name        Function name.
 * @param   function    Receives function pointer.
 * @return              Operation status. 
 */
kFx(kStatus) kDynamicLib_Function(kDynamicLib library, const kChar* name, kFunction* function);

kEndHeader()

#include <kApi/Utils/kDynamicLib.x.h>

#endif