Functions
int	mdlFuncKey_attachMenu (WCharP fullFileSpec, WCharCP filename)
	Attaches a function key menu. More...

void	mdlFuncKey_currentMenu (WCharP filename)
	Gets the current function key menu file name. More...

int	mdlFuncKey_getKeyByIndex (WCharP keyName, WCharCP string, int virtualKey, int index)
	Gets the key name, key definition and virtual key code for a function key definition. More...

int	mdlFuncKey_getKeyByVirtualKey (WCharP keyName, WCharCP string, int index, int virtualKey)
	Gets the key name, key definition and index of a function key, given the virtual key. More...

void	mdlFuncKey_getKeyName (WCharP funcKeyName, int virtualKey)
	Gets the name of the function key given virtual key code. More...

int	mdlFuncKey_numKeys ()
	Gets the number of function keys available. More...

int	mdlFuncKey_saveMenu (WCharP fullFileSpec, WCharCP filename)
	Saves the current function key menu settings to the specified file. More...

int	mdlFuncKey_define (int virtualKey, WCharCP definition)
	Adds a definition to the internal list of function key definitions. More...

int	mdlFuncKey_remove (int virtualKey)
	Removes the definition for the key virtualKey from the internal list of function key definitions. More...

Detailed Description

Function Documentation

int mdlFuncKey_attachMenu	(	WCharP	fullFileSpec,
		WCharCP	filename
	)

Attaches a function key menu.

The menu name is passed in filename. If this file specification is not complete, the environment variables MS_FKEYMNU and MS_DATA complete the specification. The complete file specification is returned in fullFileSpec.

Parameters

[out]	fullFileSpec	full menu filename
[in]	filename	file name to attach

Returns: MDLERR_CANNOTOPENFILE if the menu file cannot be opened and SUCCESS if the operation is successful.

See also: mdlFuncKey_saveMenu

void mdlFuncKey_currentMenu ( WCharP filename )

Gets the current function key menu file name.

Parameters

[out] filename full menu name

See also: mdlFuncKey_attachMenu mdlFuncKey_saveMenu

int mdlFuncKey_define	(	int	virtualKey,
		WCharCP	definition
	)

Adds a definition to the internal list of function key definitions.

If a definition already exists for the virtual key virtualKey, the definition passed by definition overwrites it.

Parameters

[in]	virtualKey	virtual key
[in]	definition	definition for key

Returns: MDLERR_BADARG if virtualKey is invalid, otherwise SUCCESS

Remarks: The definition can be any keyin that is accepted by MicroStation.

See also: mdlFuncKey_remove

int mdlFuncKey_getKeyByIndex	(	WCharP	keyName,
		WCharCP *	string,
		int *	virtualKey,
		int	index
	)

Gets the key name, key definition and virtual key code for a function key definition.

Parameters

[out]	keyName	key name
[out]	string	key definition
[out]	virtualKey	virtual key
[in]	index	position of the definition in the internal list of function key definitions.

Returns: SUCCESS if a function key definition was found at index position in the list, otherwise ERROR.

See also: mdlFuncKey_getKeyByVirtualKey mdlFuncKey_numKeys

int mdlFuncKey_getKeyByVirtualKey	(	WCharP	keyName,
		WCharCP *	string,
		int *	index,
		int	virtualKey
	)

Gets the key name, key definition and index of a function key, given the virtual key.

Parameters

[out]	keyName	key name
[out]	string	key definition
[out]	index	index in the linked list of function key definitions
[in]	virtualKey	specifies the function key's virtual key code.

Returns: SUCCESS if a function key definition exists for virtualKey, otherwise ERROR.

See also: mdlFuncKey_getKeyByIndex

void mdlFuncKey_getKeyName	(	WCharP	funcKeyName,
		int	virtualKey
	)

Gets the name of the function key given virtual key code.

Parameters

[out]	funcKeyName	key name.
[in]	virtualKey	virtual key

See also: mdlFuncKey_define

int mdlFuncKey_numKeys ( )

Gets the number of function keys available.

Returns: the number of available function keys.

See also: mdlFunckey_getKeyByIndex

int mdlFuncKey_remove ( int virtualKey )

Removes the definition for the key virtualKey from the internal list of function key definitions.

Parameters

[in] virtualKey virtual key

Returns: SUCCESS if the virtual key code virtualKey was removed, otherwise ERROR.

See also: mdlFuncKey_define

int mdlFuncKey_saveMenu	(	WCharP	fullFileSpec,
		WCharCP	filename
	)

Saves the current function key menu settings to the specified file.

Parameters

[out]	fullFileSpec	full menu file specification and name
[in]	filename	file to save function key settings to

Remarks: If the file specification in filename is not complete, the environment variables MS_FKEYMNU and MS_DATA complete the specification. The complete file specification is returned in fullFileSpec.

Returns: MDLERR_CANNOTOPENFILE if the menu file cannot be opened, or SUCCESS if the operation is successful.

See also: mdlFunckey_attachMenu

Functions

Detailed Description

Function Documentation