wsreg_initialize

- initialize wsreg library

Synopsis

cc  [flag …]  file …-lwsreg [library …] 
#include <wsreg.h>

int wsreg_initialize(Wsreg_init_level level, const char *alternate_root);

Description

The wsreg_initialize() function initializes the wsreg library.

The level argument can be one of the following:

WSREG_INIT_NORMAL

If an old registry file is present, attempt to perform a conversion.

WSREG_INIT_NO_CONVERSION

If an old conversion file is present, do not perform the conversion, but indicate that the conversion is recommended.

The alternate_root argument can be used to specify a root prefix. If NULL is specified, no root prefix is used.

Return Values

The wsreg_initialize() function can return one of the following:

WSREG_SUCCESS

The initialization was successful and no registry conversion is necessary.

WSREG_CONVERSION_RECOMMENDED

An old registry file exists and should be converted.

A conversion is attempted if the init_level argument is WSREG_INIT_NORMAL and a registry file from a previous version of the product install registry exists. If the wsreg_initialize() function returns WSREG_CONVERSION_RECOMMENDED, the user either does not have permission to update the product install registry or does not have read/write access to the previous registry file.

Usage

The wsreg_initialize() function must be called before any other wsreg library functions.

The registry conversion can take some time to complete. The registry conversion can also be performed using the graphical registry viewer /usr/bin/prodreg or by the registry converter /usr/bin/regconvert.

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

prodreg(1M), wsreg_can_access_registry(3WSREG), attributes(5)