Previous Contents Index Next |
Setup Util Programmer's Guide |
Chapter 17 Setupnvpair.h Library Reference
This chapter describes setupnvpair.h, the library containing C versions of the nvpair.h methods. It contains the following sections:
The following is a paraphrased version of the source code comments in setupnvpair.h. The full text of these comments is available in the setupnvpair.h file located in the include directory where you installed the Setup Util.
The setupnvpair.h library contains the NVPair class flattened into a set of C functions. This is done to work around the problem of exporting C++ classes on Windows NT.
Almost all methods in NVPair have been turned into C functions. The exceptions are the operator methods and those that use NSString as an argument. Overall, four or five methods were removed.
The names of the functions match the NVPair method names with minor variations. All the functions have the following name format:
In certain cases this naming method does not work. All constructors are defined as setupNVPairCreate followed by an extension to distinguish them. The destructor is named setupNVPairDestroy. The rest of the setupnvpair.h functions are documented in nsdefs.h.
Working with an NVPairHandle is similar to working with an NVPair object. You must first create it using one of the setupNVPairCreate methods. After that you are free to use any of the setupNVPair functions. When finished, simply call setupNVPairDestroy to get rid of the NVPairHandle. Keep in mind that the functions are lazy about making sure the given pointer is a legitimate NVPair object.
The following list contains most of the NVPair C++ methods flattened into C. For complete descriptions of these methods, see Chapter 26 "Nsdefs.h Library Reference."
NSAPI_EXTERN NVPairHandle setupNVPairCreateEmpty(void);
NSAPI_EXTERN NVPairHandle setupNVPairCreateFromFile(char
*inFileName);
NSAPI_EXTERN NVPairHandle setupNVPairCreateFromNVPair(void
*inNVPair);
NSAPI_EXTERN void setupNVPairDestroy(NVPairHandle inNVPair);
NSAPI_EXTERN void setupNVPairRead(NVPairHandle inNVPair, char
*inFileName);
NSAPI_EXTERN Bool setupNVPairIsEmpty(NVPairHandle inNVPair);
NSAPI_EXTERN void setupNVPairClear(NVPairHandle inNVPair);
NSAPI_EXTERN char *setupNVPairGetID(NVPairHandle inNVPair);
NSAPI_EXTERN void setupNVPairSetID(NVPairHandle inNVPair, char
*inID);
NSAPI_EXTERN char *setupNVPairGetTimeStamp(NVPairHandle inNVPair);
NSAPI_EXTERN void setupNVPairSetTimeStamp(NVPairHandle inNVPair);
NSAPI_EXTERN char *setupNVPairGet(NVPairHandle inNVPair, char
*inName);
NSAPI_EXTERN void setupNVPairSetString(NVPairHandle inNVPair, char
*inName, char *inValue);
NSAPI_EXTERN void setupNVPairSetInt(NVPairHandle inNVPair, char
*inName, int inValue);
NSAPI_EXTERN void setupNVPairSetUInt(NVPairHandle inNVPair, char
*inName, unsigned int inValue);
NSAPI_EXTERN void setupNVPairSetLong(NVPairHandle inNVPair, char
*inName, long inValue);
NSAPI_EXTERN void setupNVPairSetULong(NVPairHandle inNVPair, char
*inName, unsigned long inValue);
NSAPI_EXTERN void setupNVPairSetStringBySection(NVPairHandle
inNVPair, char *inSection, char *inName, char *inValue);
NSAPI_EXTERN void setupNVPairSetLongBySection(NVPairHandle inNVPair,
char *inSection, char *inName, long inValue);
NSAPI_EXTERN char *setupNVPairGetListItem(NVPairHandle inNVPair,
char *inName, int inIndex);
NSAPI_EXTERN char **setupNVPairGetListItems(NVPairHandle inNVPair,
char *inName);
NSAPI_EXTERN void setupNVPairFreeListItems(NVPairHandle inNVPair,
char **inItems);
NSAPI_EXTERN Bool setupNVPairInList(NVPairHandle inNVPair, char
*inName, char *inValue);
NSAPI_EXTERN Bool setupNVPairListExists(NVPairHandle inNVPair, char
*inName);
NSAPI_EXTERN void setupNVPairAddString(NVPairHandle inNVPair, char
*inList, char *inValue);
NSAPI_EXTERN void setupNVPairAddStrings(NVPairHandle inNVPair, char
*inList, char **inValues);
NSAPI_EXTERN void setupNVPairAddStringBySection(NVPairHandle
inNVPair, char *inSection, char *inList, char *inValue);
NSAPI_EXTERN void setupNVPairAddStringsBySection(NVPairHandle
inNVPair, char *inSection, char *inList, char **inValues);
NSAPI_EXTERN void setupNVPairDelList(NVPairHandle inNVPair, char
*inName);
NSAPI_EXTERN void setupNVPairDelListItem(NVPairHandle inNVPair, char
*inName, char *inItem);
NSAPI_EXTERN int setupNVPairNumName(NVPairHandle inNVPair);
NSAPI_EXTERN int setupNVPairNumList(NVPairHandle inNVPair);
NSAPI_EXTERN int setupNVPairNumListItems(NVPairHandle inNVPair, char
*inList);
NSAPI_EXTERN char *setupNVPairName(NVPairHandle inNVPair, int
inIndex);
NSAPI_EXTERN char *setupNVPairList(NVPairHandle inNVPair, int
inIndex);
NSAPI_EXTERN int setupNVPairNumSections(NVPairHandle inNVPair);
NSAPI_EXTERN NVPairHandle setupNVPairGetSectionByIndex(NVPairHandle
inNVPair, int inIndex);
NSAPI_EXTERN NVPairHandle setupNVPairGetSectionByName(NVPairHandle
inNVPair, char *inName);
NSAPI_EXTERN void setupNVPairAddSection(NVPairHandle inNVPair, char
*inName, NVPairHandle inSubBlock);
NSAPI_EXTERN NVPairHandle setupNVPairCreateSection(NVPairHandle
inNVPair, char *inName);
NSAPI_EXTERN void setupNVPairRename(NVPairHandle inNVPair, char
*inOldLabel, char *inNewLabel);
NSAPI_EXTERN void setupNVPairRemove(NVPairHandle inNVPair, char
*inLabel);
NSAPI_EXTERN void setupNVPairToUTF8(NVPairHandle inNVPair, char
*inLabel);
NSAPI_EXTERN void setupNVPairToLocal(NVPairHandle inNVPair, char
*inLabel);
NSAPI_EXTERN int setupNVPairWriteToFile(NVPairHandle inNVPair, char
*inFileName);
NSAPI_EXTERN int setupNVPairWrite(NVPairHandle inNVPair);
NSAPI_EXTERN void setupNVPairSetFormat(NVPairHandle inNVPair, int
inWhich);
Previous Contents Index Next
Copyright (C) 2005 Red Hat, Inc. All rights reserved.
This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/
Last Updated September 21, 2001