The App Object Object - SyncScan Programming Interface

Document Path: Home Page / Console Programms / SyncScan / Interfaces / App Object Object  
Properties

argc

Value int
Access Read
Notes Number of command arguments

argv

Value BSTR
Arguments:
  • int index
Access Read
Notes Retrieve a command line argument

ExitCode

Value int
Access Read, Write
Notes Set the program's exit code

Property

Value VARIANT
Arguments:
  • BSTR name
Access Read, Write
Notes for storing run-time variables.
Methods

GetShellDirectory

Return Value File Object
Arguments:
  • ULONG id
Notes 
------------------- Shell Folder IDS ----------------------------------------------
48: Administrative tools for an individual user. 
29: Nonlocalized Startup program group.
26: Common repository for application-specific data.
10: Objects in the user's Recycle Bin.
59: Files waiting to be written to CD.
47: Administrative tools for all users of the computer.
30: Nonlocalized Startup program group for all users.
35: Application data for all users.
25: Files and folders that appear on the desktop for all users.
46: Documents that are common to all users.
32: Favorite items common to all users.
53: Music files common to all users.
54: Image files common to all users. 
23: Directories for the common program groups that appear on the Start menu for all users.
22: Programs and folders that appear on the Start menu for all users.
24: Programs that appear in the Startup folder for all users.
45: Templates that are available to all users.
55: Video files common to all users.
3:  Icons for the Control Panel applications.
33: Internet cookies.
0:  Windows desktop, the root of the namespace.
16: File objects on the desktop.
17: My Computer.
6:  Favorite items.
20: Fonts.
34: Internet history items.
1:  Internet.
32: Temporary Internet files
28: Data repository for local (nonroaming) applications.
12: My Documents.
13: Music files.
39: Image files.
14: Video files.
19: My Network Places.
18: Network Neighborhood.
5:  My Documents.
4:  Installed printers.
27: Printers virtual folder..
40: The user's profile folder.
62: User profile folders.
38: The Program Files folder.
43: Components that are shared across applications.
2:  User's program groups. 
8:  Shortcuts to the user's most recently used documents.
9:  Send To menu items.
11: Start menu items.
7:  User's Startup program group.
37: Windows System folder.
21: Document templates..
36: Windows directory or SYSROOT.

GetSystemDirectory

Return Value File Object

GetTempDirectory

Return Value File Object

GetWindowsDirectory

Return Value File Object

Input

Return Value BSTR
Arguments:
  • BSTR prompt (Optional, default(""))

Print

Return Value
Arguments:
  • BSTR text

kbhit

Return Value BOOL
Notes Returns true if the user has pressed a key. The pressed key can be read by getch or getche

getch

Return Value VARIANT
Arguments:
  • BOOL returnAsInt (Optional, default(1))
Notes Returns the pressed key without displaying it. If 'returnAsInt' is true, the return value is the key-code, otherwise the return value is a single char string.

getche

Return Value VARIANT
Arguments:
  • BOOL returnAsInt (Optional, default(1))
Notes Returns the pressed key and display the key. If 'returnAsInt' is true, the return value is the key-code, otherwise the return value is a single char string.

ScanDirectory

Return Value
Arguments:
  • BSTR path
  • BOOL scanSubDirectories (Optional, default(1))
  • Object callbackFunction
Notes Scan a directory and (optionally) its sub-directories. The callback function will be called for each file and sub-directory found.

CompareDirectory

Return Value
Arguments:
  • BSTR path1
  • BSTR path2
  • BOOL scanSubDirectories (Optional, default(1))
  • Object callbackFunction
Notes Compare two directories and (optionally) their sub-directories. The callback function will be called for each file and sub-directory found.

FindFile

Return Value File Object
Arguments:
  • BSTR path

Exit

Return Value
Arguments:
  • int exitCode
Notes Terminate the program.

system

Return Value int
Arguments:
  • BSTR cmd
Notes Execute s system command. For example, "cls" or "net use..."