Macros | Functions
imginput.h File Reference
#include <Mstn\MdlApi\mssystem.fdf>

Go to the source code of this file.

Macros

#define __IMGINPUT_H__
 
#define MAXKEYINLENGTH   256
 
#define KIN_SUCCESS   0
 
#define KIN_ERROR   1 /* Invalid Key-in */
 
#define KIN_PERM_DENIED   2 /* Permission denied */
 
#define KIN_NOIMAGE   3 /* An image should be Active when Key-in activated */
 
#define KIN_INVALID_VIEW   4 /* Invalid View Number or List */
 
#define KIN_FILE_READ_ONLY   5 /* This file is read only */
 
#define KIN_NO_ACTIVE_FILE   6 /* No active file */
 
#define KIN_FILE_NOT_FOUND   7 /* The specified file was not found */
 
#define KIN_FILE_EXIST   8 /* The specified file name already exists */
 
#define KIN_FILE_ALREADY_OPEN   9 /* The specified file name is already open */
 
#define KIN_MISSING_SETTINGS   10 /* Previous settings should be made before this Key-in is called */
 
#define KIN_INVALID_SETTINGS   11 /* Previous settings are not valid for this Key-in */
 
#define KIN_INVALID_FILE_NAME   12 /* The file is already open or does not exist */
 
#define KIN_NOT_ENOUGH_SPACE   13 /* Not enough Disk space */
 
#define KIN_INVALID_PARAM   14 /* Indicates that an invalid object/parameter was given */
 
#define KIN_NEED_INTERACTION   15 /* The operation can not be performed without a user interaction */
 
#define KIN_INVALID_IMAGE_TYPE   16 /* The type of image is invalid for this Key-In (e.g.:1 bit images) */
 
#define KIN_INVALID_THEME   17 /* The theme name is invalid for this Key-In */
 
#define KIN_INVALID_COLOR   18 /* The color number is invalid for this Key-In */
 
#define KIN_INVALID_HATCH   19 /* The hatch number is invalid for this Key-In */
 
#define KIN_INVALID_PATTERN   20 /* The pattern number is invalid for this Key-In */
 
#define KIN_3DFILE_NEEDED   21 /* The dgn file needs to be 3D for this Key-in */
 
#define KIN_DESIGN_READONLY   22 /* The dgn file is read only. This key-in can not be processed */
 
#define KIN_INVALID_POINT   23 /* The given point is invalid */
 
#define KIN_AREA_OVERFLOW   24 /* Maximum area overflow */
 
#define KIN_INVALID_SERVER   25 /* The server alias is invalid for this Key-In */
 
#define KIN_MORE_THAN_1_SELECTED   26 /* More than 1 raster is selected */
 
#define KIN_INVALID_DIRECTORY   27 /* the directory doesn't exist */
 
#define REG_LONG(x)   (GetImageRegisterValueLong (x))
 
#define ERROR_CODE   (GetImageRegisterErrorCode())
 
#define REG_SHORT(x)   (GetImageRegisterValueShort (x))
 
#define REG_DOUBLE(x)   (GetImageRegisterValueDouble (x))
 
#define REG_STRING_CONT(valueHolder, x)   (GetImageRegisterStringContents (valueHolder, x))
 

Functions

int GetImageRegisterValueLong (int regNum)
 
int GetImageRegisterErrorCode ()
 
int GetImageRegisterValueShort (int regNum)
 
double GetImageRegisterValueDouble (int regNum)
 
WCharCP GetImageRegisterStringContents (WStringR valueHolder, int regNum)
 

Macro Definition Documentation

#define __IMGINPUT_H__
#define ERROR_CODE   (GetImageRegisterErrorCode())
#define KIN_3DFILE_NEEDED   21 /* The dgn file needs to be 3D for this Key-in */
#define KIN_AREA_OVERFLOW   24 /* Maximum area overflow */
#define KIN_DESIGN_READONLY   22 /* The dgn file is read only. This key-in can not be processed */
#define KIN_ERROR   1 /* Invalid Key-in */
#define KIN_FILE_ALREADY_OPEN   9 /* The specified file name is already open */
#define KIN_FILE_EXIST   8 /* The specified file name already exists */
#define KIN_FILE_NOT_FOUND   7 /* The specified file was not found */
#define KIN_FILE_READ_ONLY   5 /* This file is read only */
#define KIN_INVALID_COLOR   18 /* The color number is invalid for this Key-In */
#define KIN_INVALID_DIRECTORY   27 /* the directory doesn't exist */
#define KIN_INVALID_FILE_NAME   12 /* The file is already open or does not exist */
#define KIN_INVALID_HATCH   19 /* The hatch number is invalid for this Key-In */
#define KIN_INVALID_IMAGE_TYPE   16 /* The type of image is invalid for this Key-In (e.g.:1 bit images) */
#define KIN_INVALID_PARAM   14 /* Indicates that an invalid object/parameter was given */
#define KIN_INVALID_PATTERN   20 /* The pattern number is invalid for this Key-In */
#define KIN_INVALID_POINT   23 /* The given point is invalid */
#define KIN_INVALID_SERVER   25 /* The server alias is invalid for this Key-In */
#define KIN_INVALID_SETTINGS   11 /* Previous settings are not valid for this Key-in */
#define KIN_INVALID_THEME   17 /* The theme name is invalid for this Key-In */
#define KIN_INVALID_VIEW   4 /* Invalid View Number or List */
#define KIN_MISSING_SETTINGS   10 /* Previous settings should be made before this Key-in is called */
#define KIN_MORE_THAN_1_SELECTED   26 /* More than 1 raster is selected */
#define KIN_NEED_INTERACTION   15 /* The operation can not be performed without a user interaction */
#define KIN_NO_ACTIVE_FILE   6 /* No active file */
#define KIN_NOIMAGE   3 /* An image should be Active when Key-in activated */
#define KIN_NOT_ENOUGH_SPACE   13 /* Not enough Disk space */
#define KIN_PERM_DENIED   2 /* Permission denied */
#define KIN_SUCCESS   0
#define MAXKEYINLENGTH   256
#define REG_DOUBLE (   x)    (GetImageRegisterValueDouble (x))
#define REG_LONG (   x)    (GetImageRegisterValueLong (x))
#define REG_SHORT (   x)    (GetImageRegisterValueShort (x))
#define REG_STRING_CONT (   valueHolder,
 
)    (GetImageRegisterStringContents (valueHolder, x))

Function Documentation

int GetImageRegisterErrorCode ( )
WCharCP GetImageRegisterStringContents ( WStringR  valueHolder,
int  regNum 
)
double GetImageRegisterValueDouble ( int  regNum)
int GetImageRegisterValueLong ( int  regNum)
int GetImageRegisterValueShort ( int  regNum)

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.