henv.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        henv.h ( tools Library, C++)
 *
 * COMMENTS:    Generic environment variable handling routines.
 */

#ifndef __henv_h__
#define __henv_h__

#include "tools_API.h"
#include <SYS/SYS_Deprecated.h>

tools_API extern void            HoudiniSetenv(const char *name,
                                               const char *value);
SYS_DEPRECATED(14.0)
tools_API extern void            HoudiniPutenv(const char *namevalue);
tools_API extern const char     *HoudiniGetenv(const char *name);
tools_API extern void            HoudiniUnsetenv(const char *name);
tools_API extern char * const   *HoudiniGetenvlist();

/// RAII class for serializing work that will read/write environment variables.
/// HouiniSetenv()/HoudiniGetenv() calls are already serialized with this mutex
/// but this is intended for use on non-main threads and code that doesn't go
/// through the Houdini.*() API. These include:
///     mktime(), ctime(), localtime(), strftime(), gmtime(), etc.
class tools_API TOOLS_EnvLockGuard
{
public:
    TOOLS_EnvLockGuard();
    ~TOOLS_EnvLockGuard();

    TOOLS_EnvLockGuard(const TOOLS_EnvLockGuard &) = delete;
    TOOLS_EnvLockGuard &operator=(const TOOLS_EnvLockGuard &) = delete;
};

#endif