[apple/icu.git] / icuSources / tools / icuinfo / icuplugins_windows_sample.txt

# Copyright (C) 2016 and later: Unicode, Inc. and others.
# License & terms of use: http://www.unicode.org/copyright.html
# Copyright (C) 2009-2010 IBM Corporation and Others. All Rights Reserved.
# 
# This is a sample ICU Plugins control file for Windows.
# It's also an example control file for any platform.
#
# This file can be copied to, for example, C:\SOMEDIRECTORY\icuplugins##.txt
#  where ## is the major and minor ICU versions (i.e.  just 96 for version 9.6.3) 
#  and C:\SOMEDIRECTORY is any directory.
# 
# Then, set the variable ICU_PLUGINS to C:\SOMEDIRECTORY
#
# Then, ICU will load the test plugin from either the debug or non-debug	
# plugin DLL (depending on whether ICU is in debug or non-debug state).
#
# To see the results, run the command  "icuinfo -v -L"
#
# The format of this file is pretty simple.
# These lines are comments. 
#
# Non-comment lines have two or three elements in them, and look like this:
#    
#  LIBRARYNAME     ENTRYPOINT     [ CONFIGURATION .. ]
#
# Tabs or spaces separate the three items. 
#
# LIBRARYNAME is the name of a shared library, either a short name if it is on the PATH,
#  or a full pathname.
# 
# ENTRYPOINT is the short (undecorated) symbol name of the plugin's entrypoint.
#  see unicode/icuplug.h for information.
#
# CONFIGURATION is the entire rest of the line. It's passed as-is to the plugin.
#
#
# This sample file tries to load 'myPlugin'. 
# It is in the testplug project. (You will need to rebuild either the debug or release version of this DLL.)
# The configuration string isn't used, but is just an example

## A high level test plugin that does nothing.
testplug.dll	myPlugin	hello=world

## A "bad" plugin that is low level but performs a malloc.
##  Sometimes this is desired, but, note that it may cause
##  later plugins to fail to load.
#testplug.dll	myPluginBad	hello=world

## A "high-level" plugin that does nothing. 
##  It will be loaded after the low level plugins.
#testplug.dll	myPluginHigh

## A "low-level" plugin that does nothing.
##  It will be loaded before the high level plugins.
#testplug.dll	myPluginLow

## A low level plugin that just prints a message when uprv_malloc  and related functions are called
##  Note, it cannot be unloaded. 
#testplug.dll	debugMemoryPlugin
Commit	Line	Data
f3c0d7a5 A	1	# Copyright (C) 2016 and later: Unicode, Inc. and others.
f3c0d7a5 A	2	# License & terms of use: http://www.unicode.org/copyright.html
729e4ab9 A	3	# Copyright (C) 2009-2010 IBM Corporation and Others. All Rights Reserved.
	4	#
	5	# This is a sample ICU Plugins control file for Windows.
	6	# It's also an example control file for any platform.
	7	#
	8	# This file can be copied to, for example, C:\SOMEDIRECTORY\icuplugins##.txt
	9	# where ## is the major and minor ICU versions (i.e. just 96 for version 9.6.3)
	10	# and C:\SOMEDIRECTORY is any directory.
	11	#
	12	# Then, set the variable ICU_PLUGINS to C:\SOMEDIRECTORY
	13	#
	14	# Then, ICU will load the test plugin from either the debug or non-debug
	15	# plugin DLL (depending on whether ICU is in debug or non-debug state).
	16	#
	17	# To see the results, run the command "icuinfo -v -L"
	18	#
	19	# The format of this file is pretty simple.
	20	# These lines are comments.
	21	#
	22	# Non-comment lines have two or three elements in them, and look like this:
	23	#
	24	# LIBRARYNAME ENTRYPOINT [ CONFIGURATION .. ]
	25	#
	26	# Tabs or spaces separate the three items.
	27	#
	28	# LIBRARYNAME is the name of a shared library, either a short name if it is on the PATH,
	29	# or a full pathname.
	30	#
	31	# ENTRYPOINT is the short (undecorated) symbol name of the plugin's entrypoint.
	32	# see unicode/icuplug.h for information.
	33	#
	34	# CONFIGURATION is the entire rest of the line. It's passed as-is to the plugin.
	35	#
	36	#
	37	# This sample file tries to load 'myPlugin'.
	38	# It is in the testplug project. (You will need to rebuild either the debug or release version of this DLL.)
	39	# The configuration string isn't used, but is just an example
	40
	41	## A high level test plugin that does nothing.
	42	testplug.dll myPlugin hello=world
	43
	44	## A "bad" plugin that is low level but performs a malloc.
	45	## Sometimes this is desired, but, note that it may cause
	46	## later plugins to fail to load.
	47	#testplug.dll myPluginBad hello=world
	48
	49	## A "high-level" plugin that does nothing.
	50	## It will be loaded after the low level plugins.
	51	#testplug.dll myPluginHigh
	52
	53	## A "low-level" plugin that does nothing.
	54	## It will be loaded before the high level plugins.
	55	#testplug.dll myPluginLow
	56
	57	## A low level plugin that just prints a message when uprv_malloc and related functions are called
	58	## Note, it cannot be unloaded.
	59	#testplug.dll debugMemoryPlugin