Daylight v4.9
Release Date: 1 February 2008


dt_mp_lock - lock an object family

Generic Prototype

dt_mp_lock(dt_Handle) => dt_Boolean

C Prototype

#include "dt_smiles.h"

dt_Boolean dt_mp_lock(dt_Handle object)

FORTRAN Prototype

include ''

logical dt_f_mp_lock(object)

integer*4 object


Locks an object family within the toolkit. This function will block indefinitely until the lock for an object becomes available. If a non-blocking function is desired, dt_mp_trylock(3) may be used. The function can be used in a multi-threading program with global access of objects across threads to coordinate object access.

Return Value

Returns TRUE when the lock is acquired.

Related Topics

dt_ancestor(3) dt_mp_initialize(3) dt_mp_trylock(3) dt_mp_unlock(3)