Environment

Functions
HAPI_DECL	HAPI_GetEnvInt (HAPI_EnvIntType int_type, int *value)
	Gives back a certain environment integers like version number. Note that you do not need a session for this. These constants are hard-coded in all HAPI implementations, including HARC and HAPIL. This should be the first API you call to determine if any future API calls will mismatch implementation. More...
HAPI_DECL	HAPI_GetSessionEnvInt (const HAPI_Session *session, HAPI_SessionEnvIntType int_type, int *value)
	Gives back a certain session-specific environment integers like current license type being used. More...
HAPI_DECL	HAPI_GetServerEnvInt (const HAPI_Session *session, const char *variable_name, int *value)
	Get environment variable from the server process as an integer. More...
HAPI_DECL	HAPI_GetServerEnvString (const HAPI_Session *session, const char *variable_name, HAPI_StringHandle *value)
	Get environment variable from the server process as a string. More...
HAPI_DECL	HAPI_GetServerEnvVarCount (const HAPI_Session *session, int *env_count)
	Provides the number of environment variables that are in the server environment's process. More...
HAPI_DECL	HAPI_GetServerEnvVarList (const HAPI_Session *session, HAPI_StringHandle *values_array, int start, int length)
	Provides a list of all of the environment variables in the server's process. More...
HAPI_DECL	HAPI_SetServerEnvInt (const HAPI_Session *session, const char *variable_name, int value)
	Set environment variable for the server process as an integer. More...
HAPI_DECL	HAPI_SetServerEnvString (const HAPI_Session *session, const char *variable_name, const char *value)
	Set environment variable for the server process as a string. More...

Detailed Description

Functions for reading and writing to the session environment

Function Documentation

HAPI_DECL HAPI_GetEnvInt	(	HAPI_EnvIntType	int_type,
		int *	value
	)

Gives back a certain environment integers like version number. Note that you do not need a session for this. These constants are hard-coded in all HAPI implementations, including HARC and HAPIL. This should be the first API you call to determine if any future API calls will mismatch implementation.

Parameters

[in]	int_type	One of HAPI_EnvIntType.
[out]	value	Int value.

HAPI_DECL HAPI_GetServerEnvInt	(	const HAPI_Session *	session,
		const char *	variable_name,
		int *	value
	)

Get environment variable from the server process as an integer.

Parameters

[in]	session	The session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	variable_name	Name of the environmnet variable.
[out]	value	The int pointer to return the value in.

HAPI_DECL HAPI_GetServerEnvString	(	const HAPI_Session *	session,
		const char *	variable_name,
		HAPI_StringHandle *	value
	)

Get environment variable from the server process as a string.

Parameters

[in]	session	The session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	variable_name	Name of the environmnet variable.
[out]	value	The HAPI_StringHandle pointer to return the value in.

HAPI_DECL HAPI_GetServerEnvVarCount	(	const HAPI_Session *	session,
		int *	env_count
	)

Provides the number of environment variables that are in the server environment's process.

Note that HAPI_GetServerEnvVarList() should be called directly after this method, otherwise there is the possibility that the environment variable count of the server will have changed by the time that HAPI_GetServerEnvVarList() is called.

Parameters

[in]	session	The session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[out]	env_count	A pointer to an int to return the value in

HAPI_DECL HAPI_GetServerEnvVarList	(	const HAPI_Session *	session,
		HAPI_StringHandle *	values_array,
		int	start,
		int	length
	)

Provides a list of all of the environment variables in the server's process.

Parameters

[in]	session	The session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[out]	values_array	An HAPI_StringHandle array at least the size of length
[in]	start	First index of range. Must be at least 0 and at most env_count - 1 where env_count is the count returned by HAPI_GetServerEnvVarCount()
[in]	length	Given env_count returned by HAPI_GetServerEnvVarCount(), length should be at least 0 and at most env_count - start.

HAPI_DECL HAPI_GetSessionEnvInt	(	const HAPI_Session *	session,
		HAPI_SessionEnvIntType	int_type,
		int *	value
	)

Gives back a certain session-specific environment integers like current license type being used.

Parameters

[in]	session	The session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	int_type	One of HAPI_SessionEnvIntType.
[out]	value	Int value.

HAPI_DECL HAPI_SetServerEnvInt	(	const HAPI_Session *	session,
		const char *	variable_name,
		int	value
	)

Set environment variable for the server process as an integer.

Note that this may affect other sessions on the same server process. The session parameter is mainly there to identify the server process, not the specific session.

For in-process sessions, this will affect the current process's environment.

Parameters

[in]	session	The session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	variable_name	Name of the environment variable.
[in]	value	The integer value.

HAPI_DECL HAPI_SetServerEnvString	(	const HAPI_Session *	session,
		const char *	variable_name,
		const char *	value
	)

Set environment variable for the server process as a string.

Note that this may affect other sessions on the same server process. The session parameter is mainly there to identify the server process, not the specific session.

For in-process sessions, this will affect the current process's environment.

Parameters

[in]	session	The session of Houdini you are interacting with. See HAPI_Sessions for more on sessions. Pass NULL to just use the default in-process session.
[in]	variable_name	Name of the environmnet variable.
[in]	value	The string value.