Functions

The following table lists functions in this documentation.

	Name	Description
	CreateLogServer	CreateLogServer creates a new log server that can hold several log clients (IJwLogClient). A log sever creates a new logprocess tag and closes it if it is destroyed. It saves each xml tag into a new string list item in parameter Elements. This behavior can be overwritten by using a non default WriterClass (TJwLogWriterClass)
	Exception	Exception creates an exception information log entry.
	Exception	Exception creates an exception information log entry with log source information.
	GetEventTypesEnabled	This is function GetEventTypesEnabled.
	GetResourceStringIdentifier	GetResourceStringIdentifier converts a Delphi resourcestring into a resource identifier. Use ResourcestringName as parameter rs (e.g. RsInvalidIndex). The function cannot fail for correct delphi resourcestring identifiers otherwise the return value is undefined.
	IJwBase_Equals	IJwBase_Equals implements IJwBase.Equals and always returns false.
	IJwBase_GetHashCode	IJwBase_GetHashCode implements IJwBase.GetHashCode and always returns 0.
	IJwBase_ToString	IJwBase_ToString implements IJwBase.ToString and always returns the classname of given self parameter.
	IsGenericRight	IsGenericRight returns true if the given right has a generic (31-28) bit set; otherwise false.
	IsMaximumRight	IsMaximumRight returns true if the given right has the maximum allowed (26) bit set; otherwise false.
	IsReservedRight	IsReservedRight returns true if the given right has a reserved (27, 25) bit set; otherwise false.
	IsSACLRight	IsSACLRight returns true if the given right has the system (24) bit set; otherwise false.
	IsSpecificRight	IsSpecificRight returns true if the given right has an object specific (0..15) bit set; otherwise false.
	IsStandardRight	IsStandardRight returns true if the given right has a standard (16-23) bit set; otherwise false.
	JEDI_WebFieldsRequestNotify	This is function JEDI_WebFieldsRequestNotify.
	JwAccessMaskToBits	This is function JwAccessMaskToBits.
	JwAddHandleToArray	This is function JwAddHandleToArray.
	JwAddMapSid	JwAddMapSid adds a string to the string Sid map list. JwInitMapping must be called before.
	JwBeginCreateHash	JwBeginCreateHash begins a hash calculation and returns an hash handle that is used with other hash functions like: JwStringHash, JwIntegerHash, JwDataHash, JwObjectHash
	JwCheckAdministratorAccess	JwCheckAdministratorAccess checks if the user has administrative rights.
	JwCheckArray	JwCheckArray checks whether a object type list array is correctly formed. The array must be in a post fix order. This sequence describes the Level structure.
	JwCheckArray	JwCheckArray checks whether a object type list array is correctly formed. The array must be in a post fix order. This sequence describes the Level structure.
	JwCheckBitMask	JwCheckBitMask Checks if (Bitmask and Check) = Check
	JwCheckInitKnownSid	JwCheckInitKnownSid checks for the call of JwInitWellKnownSIDs and raises EJwsclInitWellKnownException if it was not called. There is a more detailed procedure JwsclKnownSid.JwCheckInitKnownSid which can be used to check for special well known SID variables from unit JwsclKnownSid.
	JwCheckInitKnownSid	JwCheckInitKnownSid checks whether one or more well known sid variables from unit JwsclKnownSid are initialized (not nil). If a given variable was not created the procedure raises EJwsclInitWellKnownException; otherwise it does nothing. This procedure is like JwsclUtils.JwCheckInitKnownSid but does a thorough check for the variables.
	JwCheckSuRunStatus	JwCheckSuRunStatus checks whether SuRun is availab.e SuRun is a UAC like clone that runs in Win2000, XP and newer. StatusData : This out parameter returns status information of SuRun.
	JwCheckVISTACompilerSwitch	JwCheckVISTACompilerSwitch raises an exception EJwsclVistaFeaturesDisabled if the current code isn't compiled with the VISTA compiler directive. Otherwise it does nothing.
	JwClearSidNameCache	JwClearSidNameCache removes all list entries. JwInitSidNameCache() must be called before using this procedure.
	JwCoCreateInstanceAsAdmin	JwCoCreateInstanceAsAdmin creates an out of process COM object with administrator rights and returns it in ObjectInterface. If the current is already elevated, the function just creates an COM object and returns it; otherwise the elevation dialog will be shown. The COM class must be registered in a COM type library. The executable which call this function must contain a manifest that defines "asInvoker" as the requested execution level.
	JwCoCreateInstanceAsEx	JwCoCreateInstanceAsEx creates an out of process COM object and returns it in ObjectInterface. If the current is already elevated, the function just creates an COM object and returns it; otherwise the elevation dialog will be shown. The COM class must be registered in a COM type library. The executable which call this function must contain a manifest that defines "asInvoker" as the requested execution level.
	JwCoCreateInstanceAsHighest	JwCoCreateInstanceAsHighest creates an out of process COM object with highest possible rights and returns it in ObjectInterface. If the current is already elevated, the function just creates an COM object and returns it; otherwise the elevation dialog will be shown. The COM class must be registered in a COM type library. The executable which call this function must contain a manifest that defines "asInvoker" as the requested execution level.
	JwCoGetClassFactoyAsAdmin	JwCoGetClassFactoyAsAdmin creates an out of process COM class factory object with administrator rights and returns it in ObjectInterface. If the current is already elevated, the function just creates an COM object and returns it; otherwise the elevation dialog will be shown. The COM class must be registered in a COM type library. The executable which call this function must contain a manifest that defines "asInvoker" as the requested execution level.
	JwCompareFileHash	JwCompareFileHash creates a hash from a given file and compares it to an already calculated hash.
	JwCompareString	JwCompareString compare two TJwString values using ANSICODE or UNICODE settings depending on the UNICODE compiler directive. The comparison is done using the locale user setting.
	JwCreate_MSV1_0_INTERACTIVE_LOGON	JwCreate_MSV1_0_INTERACTIVE_LOGON is a helper function to create a MSV1_0_INTERACTIVE_LOGON structure with strings that are added right behind the structure memory so it can be used by LsaLogonUser. The returned pointer can be freed by LocalFree .
	JwCreateClassHash	JwCreateClassHash calculates an integer hash value from a memory structure.
	JwCreateException	This is function JwCreateException.
	JwCreateFileHash	JwCreateFileHash creates a hash from a given file and returns the hash.
	JwCreateLSAString	This is function JwCreateLSAString.
	JwCreateProcessAsAdminUser	JwCreateProcessAsAdminUser logs on a user and creates a new process under its logon session. The user will be a member of administrators group for this process but not in the user database. In Vista the linked token will be retrieved which has the administrator group enabled. The user does not have to be an administrator at all!
	JwCreateProcessInSession	JwCreateProcessInSession creates a new process in a user's session using various ways to achieve success. This procedure needs JwInitWellKnownSIDs to be called. To run a process in another session the process needs SYSTEM rights. It means that the current process token must have the TOKEN_ASSIGN_PRIMARY right for the target token. Otherwise the CreateProcessAsUser function fails with bad error explanation (like "A call to an OS function failed"). However the procedure won't stop you from doing this!
	JwCreateRestrictedToken	JwCreateRestrictedToken creates a restricted token from the current process. Remark: The function adapts the token security permission to allow the user access to its resources created with the restricted token (by setting a different token default dacl). This is necessary if you intend to strip away the Administrators group. The function also sets the integrity level for Vista or above. If the current process token does not have the Administrators group the function just returns a copy of the current process token.
	JwCreateToString	JwCreateToString creates a comma separated string (compatible to TStringList.CommaText) with names and values. This string is used in toString() methods of JWSCL classes for property output.
	JwCreateTUnicodeString	JwCreateUnicodeStringInitializes a counted Unicode string
	JwCreateUnicodeString	JwCreateUnicodeStringReturns a pointer to an initialized unicode string
	JwCreateUnicodeStringSelfRelative	JwCreateUnicodeStringSelfRelativReturns a pointer to an initialized unicode string. The new unicode string is a continues block of memory that has an empty string with StrLen count of chars.
	JwCreateWaitableTimer	JwCreateWaitableTimer creates a waitable timer handle. For more information about the undocumented parameters, see MSDN http://msdn.microsoft.com/en-us/library/ms686289(VS.85).aspx This function does not support absolute time like the original winapi function. It means that you cannot specify a point in time.
	JwCreateWaitableTimer	JwCreateWaitableTimer creates a waitable timer handle.
	JwCreateWaitableTimerAbs	JwCreateWaitableTimerAbs is not implemented yet. It is intended to support absolute time.
	JwCreateWaitableTimerAbs	JwCreateWaitableTimerAbs is not implemented yet.
	JwDataHash	JwDataHash hashes a data structure and adds it to the given hash handle.
	JwDecryptString	JwDecryptString decrypts a string and checks for manipulation.
	JwElevateProcess	JwElevateProcess is much like JwShellExecute but also may work on Windows 2000 and XP without UAC. Instead of UAC it uses SuRun if installed. On Vista/2008 and newer it tries to use UAC. If UAC and SuRun is not available it falls back to ShellExecute with the RunAs verb. In this case a dialog pops up the receives a username and password to use (usually Administrator). If no UI is allowed the function can use another method that receives the username and password from a generated even method (OnElevationGetCredentials). In this case the process is started using Windows Secondary Logon... more
	JwEnablePrivilege	JwEnablePrivilege en- or disables a given privilege.
	JwEncryptString	JwEncryptString encrypts and protects a string.
	JwEndCreateHash	JwEndCreateHash frees a hash value created by JwBeginCreateHash and returns the hash value over all calculated hashes.
	JwFormatAccessRights	JwFormatAccessRights creates a formatted string that splits up an access mask into its rights constants. The constants can be named if parameter RightsMapping is used. Each line contains a checkbox that defines whether the access mask contains this specifc right or not. Furthermore it contains the name of the right. Lines may look like this:
	JwFormatAccessRights	JwFormatAccessRights creates a formatted string that splits up several access massk into its rights constants. The constants can be named if parameter RightsMapping is used. Each line contains one or more checkboxes that define whether the access masks contain a specifc right or not. Furthermore it contains the name of the right. A line may look like this:
	JwFormatAccessRightsSimple	JwFormatAccessRightsSimple does the same as JwFormatAccessRights but returns just a comma separated list of specific access rights names.
	JwFormatString	JwFormatString formats a ansi- or unicode string and calls JwReplaceBreaks.
	JwFormatStringEx	JwFormatStringEx behaves like JwFormatString but without calling JwReplaceBreaks
	JwFreeLSAString	This is function JwFreeLSAString.
	JWFreeLsaStringW	This is function JWFreeLsaStringW.
	JwFreeSecurityDescriptorArray	This is function JwFreeSecurityDescriptorArray.
	JwFreeSidNameCache	JwFreeSidNameCache frees the variable JwSidNameCache and sets it to nil. This procedure must be called in the end of every thread separately; this includes the main thread. This call is automatically done for the first thread!
	JwFreeThreadName	JwFreeThreadName frees the thread variable allocated by JwSetThreadName. This procedure must be call at the end of thread to avoid a memory leak in some situation.
	JwGetLogonSID	JwGetLogonSID gets the logon SID of the given window station. Remark: This function is useful if a new user must have access to the given windows station so she can create windows. One do not have to add the new user to the window station DACL. This does not work if the user is not logged on as an interactive user.
	JwGetLogonSID	fSecurityCurrentThreadUserSID : TJwSecurityThreadUserSID = nil;
	JwGetMachineSid	JwGetMachineSid returns a local or remote machine's SID. Warning: This function may need some time on remote machines.
	JwGetPrivilegeScope	JwGetPrivilegeScope creates a new privilege scope instance and activates all privileges specified in parameter Privileges. These privileges will be disabled on destruction of this instance. The instance will be automatically be destroyed if the instance pointer runs out of scope.
	JwGetPrivilegesText	JwGetPrivilegesText returns a string filled with privilege names (of current token) and their states seperated by #13#10. SE_XXXXX [enabled SE_XXXXX [disabled
	JwGetPrivilegesText	JwGetPrivilegesText returns a string filled with privilege names (of current token) and their states seperated by #13#10. SE_XXXXX [enabled] SE_XXXXX [disabled] This function returns the status of the given privileges in parameter DisplayPrivileges.
	JwGetProcessLogonSession	JwGetProcessLogonSession returns the logon session ID of the given process. By default the current process is used
	JwGetProcessSessionID	GetProcessSessionID returns the session ID of a process given by handle or ID.
	JwGetThreadName	JwGetThreadName returns the name of a thread set by JwSetThreadName. This function only returns the name of the current thread. It cannot be used with different threads than the current one. Precondition: JwSetThreadName must be called with a value of Cardinal(-1) for parameter ThreadID.
	JwGetTokenFromProcess	JwGetTokenFromProcess tries to retrieve a token from a process. For this purpose it enumerates all processes on the local machine (even from other users) and calls the callback method OnProcessFound to determine whether the given process should be used to return the token.
	JwGlobalAllocMem	JwGlobalAllocMem creates a managed memory handle by LocalAlloc. Some memory leak managers do not recognize leaks created by LocalAlloc and GlobalAlloc. Thus we create for them a GetMem memory block. Replace each call to LocalAlloc/GlobalAlloc with JwLocalAllocMem/JwGlobalAllocMem and their counter parts JwLocalFreeMem/JwGlobalFreeMem. If a counter part is not called and the program halts the memory manager will (hopefully) show the stack trace to the GetMemPointer created by JwLocalAllocMem/JwGlobalAllocMem. Warning: Do not call JwLocalAllocMem/JwGlobalAllocMem for API functions that will free the handle. GetMemPointer will remain whatsoever. Instead use LocalAlloc/GlobalAlloc. This behavior is rare but the... more
	JwGlobalFreeAndNil	JwGlobalFreeAndNil calls GlobalFree on parameter hMem and sets it to zero (0).
	JwGlobalFreeMem	JwGlobalFreeMem frees a managed GlobalAlloc handle created by JwGlobalAllocMem. The given handle will be set to 0. Refer to MSDN documentation for more information.
	JwHandlesArray	This is function JwHandlesArray.
	JwHasAccountPassword
	JwImpersonateLoggedOnUser	JwImpersonateLoggedOnUser impersonates the current logged on user (on console) and returns an interface pointer to the token. It's automatically freed and reverted to self if it runs out of scope.
	JwImpersonateLoggedOnUser	JwImpersonateLoggedOnUser impersonates the current logged on user and returns an interface pointer to the token. It's automatically freed and reverted to self if it runs out of scope.
	JwImpersonateLoggedOnUser	JwImpersonateLoggedOnUser impersonates the current logged on user and returns an interface pointer to the token. It's automatically freed and reverted to self if it runs out of scope.
	JwInitLocalizedMappings	JwInitLocalizedMappings translate all the rights mapping arrays using the resource. user language or neutral if not found JwInitLocalizedMappings(PRIMARYLANGID(GetUserDefaultUILanguage), SUBLANGID(GetUserDefaultUILanguage)); JwInitLocalizedMappings(LANG_SYSTEM_DEFAULT, SUBLANG_SYS_DEFAULT); english version JwInitLocalizedMappings(LANG_ENGLISH, SUBLANG_ENGLISH_UK); german version JwInitLocalizedMappings(LANG_GERMAN,SUBLANG_GERMAN); neutral version (using constant names) JwInitLocalizedMappings(LANG_NEUTRAL, SUBLANG_SYS_DEFAULT); JwInitLocalizedMappings(0,0);
	JwInitLsaStringW
	JwInitMapping	JwInitMapping initialises Sid name mapping. Must be called before using JwAddMapSid and JwSidMap. JwInitMapping reads JwSidMapDef and adds it to the internal list of name to Sid mappings. If a mapping could not be made, JwSidMapDefErrors will contain the index (JwSidMapDef) of the problem.
	JwInitSidNameCache	JwClearSidNameCache initializes the JwSidNameCache string list. It must be called only once for every thread. Multiple calls will create dangling pointers. This call is automatically done for the first thread!
	JwInitWellKnownSIDs	JwInitWellKnownSIDs initializes the WellKnownSID variables. This function should not be called during initialization of a Jwscl-unit since it indirectly accesses various global variables, e.g. JwProcessHeap, which might not have been initialized yet.
	JwInitWellKnownSIDsEx	JwInitWellKnownSIDsEx works like JwInitWellKnownSIDs but also inits the array JwKnownSid for additional known SIDs. It calls JwInitWellKnownSIDs automatically.
	JwInitWellKnownSIDsExAll	This is function JwInitWellKnownSIDsExAll.
	JwIntegerHash	JwIntegerHash hashes an integer and adds it to the given hash handle.
	JwIsHandleValid	IsHandleValid returns true if Handle is neither zero (0) nor INVALID_HANDLE_VALUE; otherwise false.
	JwIsMemberOfAdministratorsGroup	JwIsMemberOfAdministratorsGroup checks if the user is a direct member of the Administrators group and this group is enabled for access checking. Therefore if this group has the flag use-for-deny-only the returned value is false. This usually happens if the user is an Administrator in Windows Vista with activated UAC.
	JwIsPrivilegeSet	JwIsPrivilegeSet checks whether a given privilege is available or enabled in the current process or thread.
	JwIsSystem	JwIsSystem returns true if the current process is running in the system context. It does not matter whether the process is in fact a service or not.
	JwIsUACEnabled	JwIsUACEnabled checks whether the current Windows has UAC enabled.
	JwLoadHashFromRegistry	JwLoadHashFromRegistry loads a hash record (TJwFileHashData) to registry previously saved by JwSaveHashToRegistry.
	JwLocalAllocMem	JwLocalAllocMem creates a managed memory handle by LocalAlloc. Some memory leak managers do not recognize leaks created by LocalAlloc and GlobalAlloc. Thus we create for them a GetMem memory block. Replace each call to LocalAlloc/GlobalAlloc with JwLocalAllocMem/JwGlobalAllocMem and their counter parts JwLocalFreeMem/JwGlobalFreeMem. If a counter part is not called and the program halts the memory manager will (hopefully) show the stack trace to the GetMemPointer created by JwLocalAllocMem/JwGlobalAllocMem. Warning: Do not call JwLocalAllocMem/JwGlobalAllocMem for API functions that will free the handle. GetMemPointer will remain whatsoever. Instead use LocalAlloc/GlobalAlloc. This behavior is rare but... more
	JwLocalFreeMem	JwLocalFreeMem frees a managed LocalAlloc handle created by JwLocalAllocMem. The given handle will be set to 0. Refer to MSDN documentation for more information.
	JwMapException	This is function JwMapException.
	JwMapException	This is function JwMapException.
	JwMsgWaitForMultipleObjects	This is function JwMsgWaitForMultipleObjects.
	JwMsgWaitForMultipleObjects	JwMsgWaitForMultipleObjects encapsulates MsgWaitForMultipleObjects using an open array parameter. The function should be used to make sure that window messages are processed. In this way windows are responsible. This function returns if such a message is received.
	JwObjectHash	JwObjectHash hashes an object and adds it to the given hash handle.
	JwOutputDebugString	JwOutputDebugString calls API OutputDebugString but works with TJwString
	JwProcessIdToSessionId	JwProcessIdToSessionId returns the session ID of a process. This function uses the new API of Vista or otherwise calls just JwGetProcessSessionID. It ist faster because it does not create an object if run on Vista or newer.
	JwRaiseLastOSError	Raises EJwsclWinCallFailedException with the given parameters.
	JwRaiseOnClassTypeMisMatch	JwRaiseOnClassTypeMisMatch raises an exception EJwsclClassTypeMismatch if parameter Instance is not of type ExpectedClass. This function is like Assert but it will not be removed in a release build.
	JwRaiseOnNilMemoryBlock	JwRaiseOnNilMemoryBlock raises an exception EJwsclNilPointer if parameter P is nil; otherwise nothing happens. This function is like Assert but it will not be removed in a release build.
	JwRaiseOnNilParameter	JwRaiseOnNilParameter raises an exception EJwsclNILParameterException if parameter P is nil; otherwise nothing happens. This function is like Assert but it will not be removed in a release build.
	JwReplaceBreaks	JwReplaceBreaks replaces "r" and "n" with break line chars.
	JwRightType	JwRightType returns the type of a given right. The function checks the bits of parameter Right from higher bits to lower bits and returns the type when it finds a set bit. The order it returns a type is the following : Generic, Reserved, Maximum, SACL, Standard, Specific,
	JwSaveHashToRegistry	JwSaveHashToRegistry saves a hash record (TJwFileHashData) to registry.
	JwSecurityCurrentThreadUserSID	JwSecurityCurrentThreadUserSID gets the current process user or impersonated thread user of the current thread that is used to call this function. The caller is responsible to free the SecurityID instance. Despite its name, the function does not fail if the current thread is not impersonated. In this case the process user is returned. Use:
	JwSetThreadName	JwSetThreadName names a thread. A debugger can use this name to display a human readably identifier for a thread. JwSetThreadName must be called without using parameter ThreadID as a precondition to use JwGetThreadName .
	JwShellExecute	JwShellExecute runs a process with elevated privileges in Windows Vista. If the current is already elevated the function simply opens the given filename. The verb of shellexecute cannot be changed. This function only works on Windows Vista and newer OS versions.
	JwSidMap	JwSidMap returns a Sid instance that was connected to a name. The advantage of this type is that names are not translated. They are always the same. JwInitMapping must be called before.
	JwStringArrayIndexOf	This is function JwStringArrayIndexOf.
	JwStringHash	JwStringHash hashes a string and adds it to the given hash handle.
	JwTSUnicodeStringToJwString	JwTSUnicodeStringToJwString converts a TS_UNICODE_STRING into a TJwString
	JwUnicodeStringToJwString	JwUnicodeStringToJwString converts a UNICODE_STRING into a TJwString
	JwUNIMPLEMENTED	JwUNIMPLEMENTED raises exception EJwsclUnimplemented
	JwUNIMPLEMENTED_DEBUG	JwUNIMPLEMENTED_DEBUG raises exception EJwsclUnimplemented if compiler directive DEBUG was used to compile the source
	JwWaitForMultipleObjects	This is function JwWaitForMultipleObjects.
	JwWaitForMultipleObjects	JwWaitForMultipleObjects encapsulates WaitForMultipleObjects using an open array parameter.
	JwZeroPassword	JwZeroPassword erases securely a UNICODE or ANSICODE string.
	LoadLocalizedString	LoadLocalizedString loads a string from a resource using a language id.
	LocalizeMapping	LocalizeMapping loads the resource strings of a TJwRightsMapping record array defined in JwsclTypes.pas. To convert a rights mapping record array define a start resource string index, say 4000. This is the starting point of the resource strings, but it does not define a string. It simply contains a number that defines the count of array elements, say 4. So the record array must look like this :
	Log	Log creates an ordinary log entry with log source information.
	Log	Log creates an ordinary log entry.
	Memory	Memory creates a memory information log entry. Application can log allocations and deallocations of memory for leak search.
	Memory	Memory creates a memory information log entry with log source information. Application can log allocations and deallocations of memory for leak search.
	SetEventTypes	SetEventTypes sets the type of events which are logged of this log client
	SetEventTypesEnabled	SetEventTypesEnabled enables or disables logging. It just does not write output.
	Signal	Signal creates a signal log entry. A signal log entries is used for communcation logging. Threads or processes may use events to signal special events.
	Signal	Signal creates a signal log entry. A signal log entries is used for communcation logging. Threads or processes may use events to signal special events.

Links

Functions, Legend

Contents | Index | Home

What do you think about this topic? Send feedback!