Profile management class.

Class that an application would use to query or write user-specific initialization files.

You can construct and destruct objects of this class.

Source:

pm_profile.h:25

Author:

Dmitry A.Steklenev

Version:

$Revision: 1.5 $

Entity	Inherited From	Type	Scope	Short Description
PMProfile		constructor	public	Constructs a profile object.
PMProfile		constructor	public	Constructs a profile object of a current module.
PMProfile		constructor	public	Constructs a profile object from an existing profile handle.
~PMProfile		destructor	public	Destructs the profile object.
put_data		method	public	This method writes a binary data into the profile.
put_integer		method	public	This method writes a long integer value into the profile.
put_integer		method	public	This method writes a unsigned long integer value into the profile.
put_integer		method	public	This method writes a short integer value into the profile.
put_integer		method	public	This method writes a unsigned short integer value into the profile.
put_string		method	public	This method writes a character string into the profile.
get_size		method	public	Returns the size in bytes of the value of a specified key for a specified application in the profile.
get_data		method	public	Returns a binary data from the profile.
get_integer		method	public	Returns a long integer value from the profile.
get_integer		method	public	Returns a unsigned long integer value from the profile.
get_integer		method	public	Returns a short integer value from the profile.
get_integer		method	public	Returns a unsigned short integer value from the profile.
get_string		method	public	Returns a character string from the profile.
window_options		enum	public	Use these enumerators to to specify window save and restore options.
save_window		method	public	Saves the current size and position of the window.
rest_window		method	public	Restores the size and position of the window.
INI_SECTION		macro	public	Defines a section name for easy way profile macros.
save_string		macro	public	Easy way to save a characters string to the profile.
save_integer		macro	public	Easy way to save a integer value to the profile.
load_string		macro	public	Easy way to restore a characters string from the profile.
load_integer		macro	public	Easy way to restore a integer value from the profile.

Constructs a profile object.

Source:

pm_profile.h:38

Param:

filename

User-profile file name. This must not be the same as the current user (OS2.INI) or system initialization (OS2SYS.INI) file name.

Code:

public PMProfile (

const char * filename )

Constructs a profile object of a current module.

Source:

pm_profile.h:41

Code:

public PMProfile (

)

Constructs a profile object from an existing profile handle.

Source:

pm_profile.h:44

Code:

public PMProfile (

HINI handle )

Destructs the profile object.

Source:

pm_profile.h:47

Code:

public ~ PMProfile ( )

This method writes a binary data into the profile.

Source:

pm_profile.h:66

Params:

app	Application name. The case-dependent name of the application for which profile data is to be written. Names starting with the characters "PM_" are reserved for system use.
key	The case-dependent name of the key for which profile data is to be written. This parameter can be NULL in which case all the key or data pairs associated with app are deleted.
data	Value data. If this parameter is NULL, the data associated with the key parameter is deleted.
len	The size of the data to be written. This length should not exceed 64K bytes.

Code:

public void put_data (	const char * app ,
	const char * key ,
	const void * data ,
	unsigned long len )

This method writes a long integer value into the profile.

Source:

pm_profile.h:79

Params:

app	The case-dependent application name.
key	The case-dependent name of the key.
value	The long integer value. Also see more detailed description of the put_data parameters.

Code:

public void put_integer (	const char * app ,
	const char * key ,
	long value )

This method writes a unsigned long integer value into the profile.

Source:

pm_profile.h:92

Params:

app	The case-dependent application name.
key	The case-dependent name of the key.
value	The unsigned long integer value. Also see more detailed description of the put_data parameters.

Code:

public void put_integer (	const char * app ,
	const char * key ,
	unsigned long value )

This method writes a short integer value into the profile.

Source:

pm_profile.h:105

Params:

app	The case-dependent application name.
key	The case-dependent name of the key.
value	The short integer value. Also see more detailed description of the put_data parameters.

Code:

public void put_integer (	const char * app ,
	const char * key ,
	short value )

This method writes a unsigned short integer value into the profile.

Source:

pm_profile.h:118

Params:

app	The case-dependent application name.
key	The case-dependent name of the key.
value	The unsigned short integer value. Also see more detailed description of the put_data parameters.

Code:

public void put_integer (	const char * app ,
	const char * key ,
	unsigned short value )

This method writes a character string into the profile.

Source:

pm_profile.h:131

Params:

app	The case-dependent application name.
key	The case-dependent name of the key.
string	Pointer to a text string that ends with a null character. Also see more detailed description of the put_data parameters.

Code:

public void put_string (	const char * app ,
	const char * key ,
	const char * string )

Returns the size in bytes of the value of a specified key for a specified application in the profile.

Source:

pm_profile.h:156

Params:

app	The name of the application for which the profile data is required. If the app parameter is NULL, then the method returns the length of the buffer required to hold the enumerated list of application names, as returned by the get_data method when its app parameter is NULL. In this case, the key parameter is ignored.
key	Key name. The name of the key for which the size of the data is to be returned. If the key parameter is NULL, and if the app parameter is not NULL, the method returns the length of the buffer required to hold the enumerated list of key names for that application name, as returned by the get_data method when its key parameter is NULL, and its app parameter is not NULL.

Returns:

The length of the value data related to the key parameter. If an error occurs, returns 0. The maximum size of data than can be returned is 64K bytes.

Code:

public unsigned long get_size (	const char * app ,
	const char * key ) const