Main Page | Modules | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 
mi32

rvcparms.h File Reference

<mi32/rvcparms.h> More...

#include <mi32/rvcdefns.h>
#include <mi32/rvctext.h>

Include dependency graph for rvcparms.h:

Include dependency graph

This graph shows which files directly or indirectly include this file:

Included by dependency graph

Go to the source code of this file.

Classes

struct  MISTRUCTDATA
struct  RVCPARMINFO
 Parameter header structure. More...

Defines

#define DPARMUSAGE_Display   0
#define DPARMUSAGE_Edit   1
#define DPARMUSAGE_NumericOutput   2
#define DPARMUSAGE_Surface   3
#define DPARMUSAGE_Unspecified   99
#define MISTRUCT_Byte   3
#define MISTRUCT_Color   11
#define MISTRUCT_Double   10
#define MISTRUCT_DRectXY   12
#define MISTRUCT_End   0
#define MISTRUCT_Float   16
#define MISTRUCT_Int   9
#define MISTRUCT_Long   7
#define MISTRUCT_MISTRING   21
#define MISTRUCT_MLString   14
#define MISTRUCT_MLUCString   15
#define MISTRUCT_String   1
#define MISTRUCT_StringPtr   17
#define MISTRUCT_Struct   18
#define MISTRUCT_StructArray   20
#define MISTRUCT_StructPtr   19
#define MISTRUCT_UByte   2
#define MISTRUCT_UCString   13
#define MISTRUCT_UInt   8
#define MISTRUCT_ULong   6
#define MISTRUCT_UWord   4
#define MISTRUCT_Word   5
#define MISTRUCTFLAG_EqualsSigns   0x2000
#define MISTRUCTFLAG_INIFormat   (MISTRUCTFLAG_NoOuterBraces|MISTRUCTFLAG_EqualsSigns)
#define MISTRUCTFLAG_NoOuterBraces   0x4000
#define MISTRUCTFLAG_NoRead   0x0004
#define MISTRUCTFLAG_NoWrite   0x0002
#define MISTRUCTFLAG_NoWrite0   0x0001
#define MISTRUCTFLAG_UseUnicode   0x8000

Typedefs

typedef RVCPARMINFO RVCDPARMINFO

Functions

int DEPRECATED MfCloseParms (int id, RVCPARMINFO *info)
int DEPRECATED MfMakeParms (int fid, RVCPARMINFO *info, UINT32 flags)
int DEPRECATED MfOpenParms (int fid, INT32 inode, RVCPARMINFO *info, UINT32 flags)
int MfReadDispParmHeader (int fhandle, RVCINODENUM inode, RVCPARMINFO *info)
int DEPRECATED MfReadParms (int handle, MISTRUCTDATA *kwdata, void *data, UINT32 flags)
int MfWriteDispParmHeader (int fhandle, RVCINODENUM inode, RVCPARMINFO *info)
int DEPRECATED MfWriteParms (int handle, MISTRUCTDATA *kwdata, void *data, UINT32 flags)
 PREVENT_MEMFUNC (RVCPARMINFO)

Detailed Description

<mi32/rvcparms.h>

Functions for saving/loading structures in the style of dispwsl.c, but much simpler. Currently used for OTYPE_DBPARM. Objects of this type are based on OTYPE_TEXT with no changes to the structure.

Definition in file rvcparms.h.

Define Documentation

#define DPARMUSAGE_Display   0
 

Definition at line 182 of file rvcparms.h.

#define DPARMUSAGE_Edit   1
 

Definition at line 183 of file rvcparms.h.

#define DPARMUSAGE_NumericOutput   2
 

Definition at line 184 of file rvcparms.h.

#define DPARMUSAGE_Surface   3
 

Definition at line 185 of file rvcparms.h.

#define DPARMUSAGE_Unspecified   99
 

Definition at line 186 of file rvcparms.h.

#define MISTRUCT_Byte   3
 

Definition at line 119 of file rvcparms.h.

#define MISTRUCT_Color   11
 

Definition at line 127 of file rvcparms.h.

#define MISTRUCT_Double   10
 

Definition at line 126 of file rvcparms.h.

#define MISTRUCT_DRectXY   12
 

Definition at line 128 of file rvcparms.h.

#define MISTRUCT_End   0
 

Definition at line 116 of file rvcparms.h.

#define MISTRUCT_Float   16
 

The 4-byte variety.

Definition at line 132 of file rvcparms.h.

#define MISTRUCT_Int   9
 

Definition at line 125 of file rvcparms.h.

#define MISTRUCT_Long   7
 

Definition at line 123 of file rvcparms.h.

#define MISTRUCT_MISTRING   21
 

Definition at line 137 of file rvcparms.h.

#define MISTRUCT_MLString   14
 

Multi-line String.

Definition at line 130 of file rvcparms.h.

#define MISTRUCT_MLUCString   15
 

Multi-line Unicode String.

Definition at line 131 of file rvcparms.h.

#define MISTRUCT_String   1
 

Definition at line 117 of file rvcparms.h.

#define MISTRUCT_StringPtr   17
 

Just a pointer in the structure.

Definition at line 133 of file rvcparms.h.

#define MISTRUCT_Struct   18
 

Definition at line 134 of file rvcparms.h.

#define MISTRUCT_StructArray   20
 

An array of structures.

Definition at line 136 of file rvcparms.h.

#define MISTRUCT_StructPtr   19
 

Definition at line 135 of file rvcparms.h.

#define MISTRUCT_UByte   2
 

Definition at line 118 of file rvcparms.h.

#define MISTRUCT_UCString   13
 

Definition at line 129 of file rvcparms.h.

#define MISTRUCT_UInt   8
 

Definition at line 124 of file rvcparms.h.

#define MISTRUCT_ULong   6
 

Definition at line 122 of file rvcparms.h.

#define MISTRUCT_UWord   4
 

Definition at line 120 of file rvcparms.h.

#define MISTRUCT_Word   5
 

Definition at line 121 of file rvcparms.h.

#define MISTRUCTFLAG_EqualsSigns   0x2000
 

Put "name=value".

Definition at line 107 of file rvcparms.h.

#define MISTRUCTFLAG_INIFormat   (MISTRUCTFLAG_NoOuterBraces|MISTRUCTFLAG_EqualsSigns)
 

Definition at line 109 of file rvcparms.h.

#define MISTRUCTFLAG_NoOuterBraces   0x4000
 

No open/close { }.

Definition at line 106 of file rvcparms.h.

#define MISTRUCTFLAG_NoRead   0x0004
 

For really old things.

Definition at line 98 of file rvcparms.h.

#define MISTRUCTFLAG_NoWrite   0x0002
 

For old things.

Definition at line 97 of file rvcparms.h.

#define MISTRUCTFLAG_NoWrite0   0x0001
 

Don't write if blank.

Definition at line 96 of file rvcparms.h.

#define MISTRUCTFLAG_UseUnicode   0x8000
 

Definition at line 105 of file rvcparms.h.

Typedef Documentation

typedef RVCPARMINFO RVCDPARMINFO
 

Definition at line 178 of file rvcparms.h.

Function Documentation

int DEPRECATED MfCloseParms (  int  id,
RVCPARMINFO *  info
) 
 

Close the object.

Parameters:
id  Object handle
info  Structure

int DEPRECATED MfMakeParms (  int  fid,
RVCPARMINFO *  info,
UINT32  flags
) 
 

Create the object and make sure it's the right OTYPE of this.

Parameters:
fid  Open file handle
info  RVCPARMINFO structure to write from
flags  Flags

int DEPRECATED MfOpenParms (  int  fid,
INT32  inode,
RVCPARMINFO *  info,
UINT32  flags
) 
 

Open the object and make sure it's the right OTYPE of this.

Parameters:
fid  Open file handle
inode  Object inode
info  RVCPARMINFO structure to fill in
flags  Flags

int MfReadDispParmHeader (  int  fhandle,
RVCINODENUM  inode,
RVCPARMINFO *  info
)  [inline]
 

Read parameter header.

Parameters:
fhandle  Open file handle
inode  Parameter object inode
info  Parameter header passed / returned

Definition at line 189 of file rvcparms.h.

int DEPRECATED MfReadParms (  int  handle,
MISTRUCTDATA *  kwdata,
void *  data,
UINT32  flags
) 
 

Read the object.

Deprecated:
use SERIALIZER instead.
Parameters:
handle  Object handle
kwdata  Reading parameters
data  Data structure to fill in
flags  Flags

int MfWriteDispParmHeader (  int  fhandle,
RVCINODENUM  inode,
RVCPARMINFO *  info
)  [inline]
 

Write parameter header.

Parameters:
fhandle  Open file handle
inode  Parameter object inode
info  Parameter header to write

Definition at line 198 of file rvcparms.h.

int DEPRECATED MfWriteParms (  int  handle,
MISTRUCTDATA *  kwdata,
void *  data,
UINT32  flags
) 
 

Write the object.

Deprecated:
use SERIALIZER instead.
Parameters:
handle  Object handle
kwdata  Writing parameters
data  Data structure to write
flags  Flags

PREVENT_MEMFUNC (  RVCPARMINFO   ) 
 

Generated on Wed May 31 15:27:50 2006 for TNTsdk by  doxygen 1.3.8-20040913