INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "Visual Eiffel Library.", "Win32 API: Profile (.INI files) Functions"
project: "Visual Eiffel Win32 Library"
revision: "$Revision: 1.1 $"
copyright: "Copyright (C) 1996-2005 Object Tools Group"
license: "http://visual-eiffel.com/license"
cluster: winlib
class WAPI_PROFILE_FUNCTIONS
feature -- Access: Private profile functions

GetPrivateProfileSectionNames (lpszreturnbuffer: POINTER; nsize: INTEGER; lpfilename: POINTER): INTEGER
-- DWORD
-- Retrieves the names of all sections in an initialization file.
-- The return value specifies the number of characters copied to the
-- specified buffer, not including the terminating null character.
-- If the buffer is not large enough to contain all the section names
-- associated with the specified initialization file, the return value
-- is equal to the length specified by nSize minus two

GetPrivateProfileSection (lpappname: POINTER; lpreturnedstring: POINTER; nsize: INTEGER; lpfilename: POINTER): INTEGER
-- DWORD
-- The GetPrivateProfileSection function retrieves all of the keys
-- and values for the specified section from an initialization file
require
win95_constraint:

GetPrivateProfileString (lpappname: POINTER; lpkeyname: POINTER; lpdefault: POINTER; lpreturnedstring: POINTER; nsize: INTEGER; lpfilename: POINTER): INTEGER
-- DWORD
-- Retrieves a string from the specified section in an
-- initialization file
-- If the function succeeds, the return value is the number of
-- characters copied to the buffer, not including the terminating
-- null character.
-- If neither lpAppName nor lpKeyName is NULL and the supplied
-- destination buffer is too small to hold the requested string,
-- the string is truncated and followed by a null character, and
-- the return value is equal to nSize minus one.
-- If either lpAppName or lpKeyName is NULL and the supplied
-- destination buffer is too small to hold all the strings, the
-- last string is truncated and followed by two null characters.
-- In this case, the return value is equal to nSize minus two.
require
non_null_lpdefault: lpkeyname /= default_pointer implies lpdefault /= default_pointer

GetPrivateProfileInt (lpappname: POINTER; lpkeyname: POINTER; ndefault: INTEGER; lpfilename: POINTER): INTEGER
-- UINT
-- Retrieves an integer associated with a key in the specified
-- section of the given initialization file
-- If the function succeeds, the return value is the integer
-- equivalent of the string following the specified key name
-- in the specified initialization file. If the key is not found,
-- the return value is the specified default value. If the value
-- of the key is less than zero, the return value is zero.

GetPrivateProfileStruct (lpszsection: POINTER; lpszkey: POINTER; lpstruct: POINTER; usizestruct: INTEGER; szfile: POINTER): BOOLEAN
-- BOOL
-- Retrieves the data associated with the specified key
-- in the given section of an initialization file. As it
-- retrieves the data, the function calculates a checksum and
-- compares it with the checksum calculated by the
-- WritePrivateProfileStruct function when the data was added
-- to the file
-- If the function succeeds, the return value is TRUE.
-- If the function fails, the return value is FALSE.

WritePrivateProfileString (lpappname: POINTER; lpkeyname: POINTER; lpstring: POINTER; lpfilename: POINTER): BOOLEAN
-- BOOL
-- Copies a string into the specified section of the specified
-- initialization file
-- If the function successfully copies the string to the
-- initialization file, the return value is TRUE.
-- If the function fails, or if it flushes the cached version
-- of the most recently accessed initialization file, the return
-- value is FALSE.
-- To get extended error information, call GetLastError.
require
win95_constraint:

WritePrivateProfileSection (lpappname: POINTER; lpstring: POINTER; lpfilename: POINTER): BOOLEAN
-- BOOL
-- Replaces the keys and values under the specified section
-- in an initialization file
-- If the function succeeds, the return value is TRUE.
-- If the function fails, the return value is FALSE.
-- To get extended error information, call GetLastError.

WritePrivateProfileStruct (lpszsection: POINTER; lpszkey: POINTER; lpstruct: POINTER; usizestruct: INTEGER; szfile: POINTER): BOOLEAN
-- BOOL
-- Copies data into the specified key in the given section
-- of an initialization file. As it copies the data,
-- the function calculates a checksum and appends it to the end
-- of the data. The GetPrivateProfileStruct function uses
-- the checksum to ensure the integrity of the data.
-- If the function successfully copies the string to the
-- initialization file, the return value is TRUE.
-- If the function fails, or if it flushes the cached version
-- of the most recently accessed initialization file,
-- the return value is FALSE.
-- To get extended error information, call GetLastError.
end -- class WAPI_PROFILE_FUNCTIONS

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES