Method

CogPlatformsetup

Declaration [src]

gboolean
cog_platform_setup (
  CogPlatform* platform,
  CogShell* shell,
  const char* params,
  GError** error
)

Description [src]

Configure the platform plug-in module.

If the params string is NULL or empty, the value of the COG_PLATFORM_PARAMS environment variable will be used, if defined. Each platform module may have its own syntax for the parameters string, but typically they accept a list of comma-separated variable=value assignments.

The documentation for each platform plug-in details the available parameters and deviations of the parameter string syntax, if applicable.

Parameters

`shell`	`CogShell`
	The shell being configured.
	The data is owned by the caller of the function.
`params`	`const char*`
	String with parameters for the platform plug-in.
	The argument can be `NULL`.
	The data is owned by the caller of the function.
	The value is a NUL terminated UTF-8 string.
`error`	`GError **`
	The return location for a `GError*`, or `NULL`.

Return value

Returns:	`gboolean`
	Whether the platform was configured successfully.