Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in / Register
pykd pykd
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 19
    • Issues 19
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • Operations
    • Operations
    • Incidents
  • Analytics
    • Analytics
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • pykd
  • pykdpykd
  • Wiki
  • API Reference

Last edited by ussrhero Oct 03, 2019
Page history

API Reference

Functions

  • addSyntheticModule
  • addSyntheticSymbol
  • addr64
  • appendSrcPath
  • appendSymbolPath
  • attachKernel
  • attachProcess
  • breakin
  • bugCheckData
  • callExt
  • callFunctionByAddr
  • callFunctionByPtr
  • callFunctionRaw
  • changeDebugOptions
  • closeDump
  • compareMemory
  • containingRecord
  • createStruct
  • createUnion
  • currentTime
  • dbgCommand
  • defineFunction
  • deinitialize
  • detachAllProcesses
  • detachProcess
  • dinput
  • dprint
  • dprintln
  • enumTagged
  • evalExpr
  • expr
  • findMemoryRegion
  • findSymbol
  • findSymbolAndDisp
  • getBp
  • getCPUMode
  • getCPUType
  • getCurrentProcess
  • getCurrentProcessId
  • getCurrentThread
  • getCurrentThreadId
  • getDebugOptions
  • getExecutionStatus
  • getExtensionSearchPath
  • getFP
  • getFrame
  • getFrameNumber
  • getHostProcessPath
  • getIP
  • getImplicitProcess
  • getImplicitThread
  • getLastEvent
  • getLastException
  • getLocal
  • getLocalProcesses
  • getLocals
  • getModulesList
  • getNumberBreakpoints
  • getNumberProcesses
  • getNumberRegisters
  • getNumberThreads
  • getOffset
  • getOutputMask
  • getParam
  • getParams
  • getProcessExeName
  • getProcessId
  • getProcessIdBySystemID
  • getProcessOffset
  • getProcessSystemID
  • getProcessThreads
  • getRegisterName
  • getSP
  • getSourceFile
  • getSourceFileFromSrcSrv
  • getSourceLine
  • getSrcPath
  • getStack
  • getSymbolPath
  • getSymbolProviderFromSource
  • getSystemVersion
  • getTargetProcesses
  • getThreadId
  • getThreadIdByOffset
  • getThreadIdBySystemID
  • getThreadOffset
  • getThreadSystemID
  • getTypeFromSource
  • getTypeInfoProviderFromPdb
  • getTypeInfoProviderFromSource
  • getVaProtect
  • go
  • initialize
  • is64bitSystem
  • isDumpAnalyzing
  • isKernelDebugging
  • isLocalKernelDebuggerEnabled
  • isVaRegionValid
  • isValid
  • isWindbgExt
  • killAllProcesses
  • killProcess
  • loadAnsiString
  • loadBytes
  • loadCStr
  • loadChars
  • loadDWords
  • loadDoubles
  • loadDump
  • loadExt
  • loadFloats
  • loadPtrList
  • loadPtrs
  • loadQWords
  • loadSignBytes
  • loadSignDWords
  • loadSignQWords
  • loadSignWords
  • loadTaggedBuffer
  • loadUnicodeString
  • loadWChars
  • loadWStr
  • loadWords
  • pageSize
  • popStack
  • ptrByte
  • ptrDWord
  • ptrDouble
  • ptrFloat
  • ptrMWord
  • ptrPtr
  • ptrQWord
  • ptrSignByte
  • ptrSignDWord
  • ptrSignMWord
  • ptrSignQWord
  • ptrSignWord
  • ptrSize
  • ptrWord
  • pushStack
  • rdmsr
  • reg
  • remoteConnect
  • removeAllBp
  • removeBp
  • removeExt
  • removeSyntheticModule
  • removeSyntheticSymbol
  • resetFrame
  • searchMemory
  • setBp
  • setByte
  • setCPUMode
  • setCurrentProcess
  • setCurrentProcessId
  • setCurrentThread
  • setCurrentThreadId
  • setDWord
  • setDouble
  • setFP
  • setFloat
  • setFrame
  • setIP
  • setImplicitProcess
  • setImplicitThread
  • setOutputMask
  • setPtr
  • setQWord
  • setReg
  • setSP
  • setSignByte
  • setSignDWord
  • setSignQWord
  • setSignWord
  • setSrcPath
  • setStatusMessage
  • setSymSrvDir
  • setSymbolPath
  • setWord
  • sizeof
  • sourceStep
  • sourceStepOver
  • stackAlloc
  • stackFree
  • startProcess
  • step
  • stepout
  • switchCPUMode
  • systemUptime
  • trace
  • typedVarArray
  • typedVarList
  • writeBytes
  • writeCStr
  • writeDWords
  • writeDoubles
  • writeDump
  • writeFloats
  • writeQWords
  • writeSignBytes
  • writeSignDWords
  • writeSignQWords
  • writeSignWords
  • writeWStr
  • writeWords
  • wrmsr

Classes

  • CPUException
  • CPUType
  • CallException
  • DbgException
  • FileFlag
  • FixedFileInfo
  • Location
  • MemoryException
  • ProcessDebugOptions
  • SymbolException
  • TypeException
  • baseTypes
  • breakpoint
  • breakpointAccess
  • callingConvention
  • cpu
  • debugEvent
  • debugOptions
  • din
  • disasm
  • dout
  • eventHandler
  • eventResult
  • eventType
  • exceptionInfo
  • executionStatus
  • memoryProtect
  • module
  • numVariant
  • outputFlag
  • stackFrame
  • symbolIterator
  • symbolProvider
  • syntheticSymbol
  • systemVersion
  • targetHeap
  • targetHeapIterator
  • targetProcess
  • targetSystem
  • targetThread
  • typeInfo
  • typeInfoProvider
  • typeInfoProviderIterator
  • typedVar
  • typedVarIterator

Function addSyntheticModule


addSyntheticModule( (int)base, (int)size, (str)name [, (str)path]) -> None :
    The addSyntheticModule function adds a synthetic module to the module list the debugger maintains for the current process

    C++ signature :
        void addSyntheticModule(unsigned __int64,unsigned long,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >])

Function addSyntheticSymbol


addSyntheticSymbol( (int)arg1, (int)arg2, (str)arg3) -> syntheticSymbol :
    The addSyntheticSymbol function adds a synthetic symbol to a module in the current process
    Note: reloading the symbols for the module deletes all synthetic symbols associated with that module.

    C++ signature :
        struct kdlib::SyntheticSymbol addSyntheticSymbol(unsigned __int64,unsigned long,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function addr64


addr64( (int)arg1) -> int :
    Extend address to 64 bits formats

    C++ signature :
        unsigned __int64 addr64(unsigned __int64)

Function appendSrcPath


appendSrcPath( (str)arg1) -> None :
    Append current source path

    C++ signature :
        void appendSrcPath(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function appendSymbolPath


appendSymbolPath( (str)arg1) -> None :
    Append current symbol path

    C++ signature :
        void appendSymbolPath(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function attachKernel


attachKernel([  (str)connectOptions]) -> None :
    Connect the debugger engine to a kernel target.
    If connectOptions is not specified - attach to the local kernel

    C++ signature :
        void attachKernel([ class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >])

Function attachProcess


attachProcess( (int)pid [, (int)debugOptions]) -> int :
    Attach debugger to a exsisting process

    C++ signature :
        unsigned long attachProcess(unsigned long [,unsigned long])

Function breakin


breakin() -> None :
    Break into debugger

    C++ signature :
        void breakin()

Function bugCheckData


bugCheckData() -> tuple :
    Function reads the kernel bug check code and related parameters
    And return tuple: (code, arg1, arg2, arg3, arg4)

    C++ signature :
        class boost::python::tuple bugCheckData()

Function callExt


callExt( (int)arg1, (str)arg2, (str)arg3) -> str :
    Call a WinDBG extension's routine. Parameters: handle returned by loadExt; string command line

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > callExt(unsigned __int64,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function callFunctionByAddr


object callFunctionByAddr(tuple args, dict kwds) :

    C++ signature :
        object callFunctionByAddr(tuple args, dict kwds)

Function callFunctionByPtr


object callFunctionByPtr(tuple args, dict kwds) :

    C++ signature :
        object callFunctionByPtr(tuple args, dict kwds)

Function callFunctionRaw


object callFunctionRaw(tuple args, dict kwds) :

    C++ signature :
        object callFunctionRaw(tuple args, dict kwds)

Function changeDebugOptions


changeDebugOptions( (int)arg1, (int)arg2) -> None :
    Change debug options

    C++ signature :
        void changeDebugOptions(unsigned long {lvalue},unsigned long {lvalue})

Function closeDump


closeDump([  (int)id]) -> None :
    Close crash dump

    C++ signature :
        void closeDump([ unsigned long])

Function compareMemory


compareMemory( (int)offset1, (int)offset2, (int)length [, (bool)phyAddr]) -> bool :
    Compare two memory buffers by virtual or physical addresses

    C++ signature :
        bool compareMemory(unsigned __int64,unsigned __int64,unsigned __int64 [,bool])

Function containingRecord


containingRecord( (int)arg1, (str)arg2, (str)arg3) -> typedVar :
    Return instance of the typedVar class. It's value are loaded from the target memory.The start address is calculated by the same method as the standard macro CONTAINING_RECORD does

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> containingRecord(unsigned __int64,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

containingRecord( (int)arg1, (typeInfo)arg2, (str)arg3) -> typedVar :
    Return instance of the typedVar class. It's value are loaded from the target memory.The start address is calculated by the same method as the standard macro CONTAINING_RECORD does

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> containingRecord(unsigned __int64,class boost::shared_ptr<class kdlib::TypeInfo> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function createStruct


createStruct( (str)name [, (int)align]) -> typeInfo :
    Create custom struct

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> createStruct(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,unsigned __int64])

Function createUnion


createUnion( (str)name [, (int)align]) -> typeInfo :
    Create custom union

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> createUnion(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,unsigned __int64])

Function currentTime


currentTime() -> int :
    Return the number of seconds since the beginning of 1970

    C++ signature :
        unsigned long currentTime()

Function dbgCommand


dbgCommand( (str)command [, (bool)suppressOutput]) -> object :
    Run a debugger's command and return it's result as a string

    C++ signature :
        class boost::python::api::object dbgCommand(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,bool])

Function defineFunction


defineFunction( (typeInfo)returnType [, (callingConvention)callconv]) -> typeInfo :
    Define custom function prototype

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> defineFunction(class boost::shared_ptr<class kdlib::TypeInfo> [,enum kdlib::CallingConventionType])

Function deinitialize


deinitialize() -> None :
    Deintialize debug engine, only for console mode

    C++ signature :
        void deinitialize()

Function detachAllProcesses


detachAllProcesses() -> None :
    Detach from all process and resume all their threads

    C++ signature :
        void detachAllProcesses()

Function detachProcess


detachProcess([  (int)id]) -> None :
    Stop process debugging

    C++ signature :
        void detachProcess([ unsigned long])

Function dinput


dinput( (str)arg1) -> None :
    Provide input for debugger

    C++ signature :
        void dinput(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function dprint


dprint( (str)str [, (bool)dml]) -> None :
    Print out string. If dml = True string is printed with dml highlighting ( only for windbg )

    C++ signature :
        void dprint(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,bool])

Function dprintln


dprintln( (str)str [, (bool)dml]) -> None :
    Print out string and insert end of line symbol. If dml = True string is printed with dml highlighting ( only for windbg )

    C++ signature :
        void dprintln(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,bool])

Function enumTagged


enumTagged() -> list :
    Return the list of secondary callback data IDs (as a strings)

    C++ signature :
        class boost::python::list enumTagged()

Function evalExpr


evalExpr( (str)expression [, (object)scope [, (typeInfoProvider)typeProvider]]) -> typedVar :
    Evaluate C++ expression with typed information

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> evalExpr(class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > [,class boost::python::api::object {lvalue} [,class boost::shared_ptr<class kdlib::TypeInfoProvider> {lvalue}]])

Function expr


expr( (str)expression [, (bool)cplusplus]) -> object :
    Evaluate windbg expression

    C++ signature :
        class boost::python::api::object expr(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,bool])

Function findMemoryRegion


findMemoryRegion( (int)arg1) -> tuple :
    Return address of begining valid memory region nearest to offset

    C++ signature :
        class boost::python::tuple findMemoryRegion(unsigned __int64)

Function findSymbol


findSymbol( (int)offset [, (bool)showDisplacement]) -> str :
    Find symbol by the target virtual memory offset

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > findSymbol(unsigned __int64 [,bool])

Function findSymbolAndDisp


findSymbolAndDisp( (int)arg1) -> tuple :
    Return tuple (module_name, symbol_name, displacement) by virtual address

    C++ signature :
        class boost::python::tuple findSymbolAndDisp(unsigned __int64)

Function getBp


getBp( (int)arg1) -> breakpoint :
    Return breakpoint object by index

    C++ signature :
        class pykd::Breakpoint * __ptr64 getBp(unsigned long)

Function getCPUMode


getCPUMode() -> CPUType :
    Return current processor mode: CPUType

    C++ signature :
        enum kdlib::CPUType getCPUMode()

Function getCPUType


getCPUType() -> CPUType :
    Return type of physical processor: CPUType

    C++ signature :
        enum kdlib::CPUType getCPUType()

Function getCurrentProcess


getCurrentProcess() -> int :
    Return current offset

    C++ signature :
        unsigned __int64 getCurrentProcess()

Function getCurrentProcessId


getCurrentProcessId() -> int :
    Return current process ID

    C++ signature :
        unsigned long getCurrentProcessId()

Function getCurrentThread


getCurrentThread() -> int :
    Return current thread offset

    C++ signature :
        unsigned __int64 getCurrentThread()

Function getCurrentThreadId


getCurrentThreadId() -> int :
    Return current thread ID

    C++ signature :
        unsigned long getCurrentThreadId()

Function getDebugOptions


getDebugOptions() -> int :
    Return debug options

    C++ signature :
        unsigned long getDebugOptions()

Function getExecutionStatus


getExecutionStatus() -> executionStatus :
    Return current execution status

    C++ signature :
        enum kdlib::ExecutionStatus getExecutionStatus()

Function getExtensionSearchPath


getExtensionSearchPath() -> str :
    Return the extension DLL search path

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > getExtensionSearchPath()

Function getFP


getFP() -> int :
    Return frame pointer

    C++ signature :
        unsigned __int64 getFP()

Function getFrame


getFrame() -> stackFrame :
    Return a current stack frame

    C++ signature :
        class boost::shared_ptr<class kdlib::StackFrame> getFrame()

Function getFrameNumber


getFrameNumber() -> int :
    Return current frame number

    C++ signature :
        unsigned long getFrameNumber()

Function getHostProcessPath


getHostProcessPath() -> str :
    Return image path of the process running python interpreter with a pykd

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > getHostProcessPath()

Function getIP


getIP() -> int :
    Return instruction pointer

    C++ signature :
        unsigned __int64 getIP()

Function getImplicitProcess


getImplicitProcess() -> int :
    Return implicit process

    C++ signature :
        unsigned __int64 getImplicitProcess()

Function getImplicitThread


getImplicitThread() -> int :
    Return implicit thread

    C++ signature :
        unsigned __int64 getImplicitThread()

Function getLastEvent


getLastEvent() -> debugEvent :
    Get last debug event information

    C++ signature :
        struct pykd::DebugEvent getLastEvent()

Function getLastException


getLastException() -> exceptionInfo :
    Get last exception  information

    C++ signature :
        struct kdlib::ExceptionInfo getLastException()

Function getLocal


getLocal( (str)arg1) -> typedVar :
    Get the fucntion's local variable by name

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> getLocal(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function getLocalProcesses


getLocalProcesses() -> list :
    Return list of runnng processes on the host system

    C++ signature :
        class boost::python::list getLocalProcesses()

Function getLocals


getLocals() -> list :
    Get list of local variables

    C++ signature :
        class boost::python::list getLocals()

Function getModulesList


getModulesList() -> list :
    Return list of modules for the current target

    C++ signature :
        class boost::python::list getModulesList()

Function getNumberBreakpoints


getNumberBreakpoints() -> int :
    Return number of breakpoints in the current process

    C++ signature :
        unsigned long getNumberBreakpoints()

Function getNumberProcesses


getNumberProcesses() -> int :
    Return number of processes on the target system

    C++ signature :
        unsigned long getNumberProcesses()

Function getNumberRegisters


getNumberRegisters() -> int :
    Return a number of CPU registers

    C++ signature :
        unsigned long getNumberRegisters()

Function getNumberThreads


getNumberThreads() -> int :
    Return number of threads on the current system

    C++ signature :
        unsigned long getNumberThreads()

Function getOffset


getOffset( (str)arg1) -> int :
    Return traget virtual address for specified symbol

    C++ signature :
        unsigned __int64 getOffset(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function getOutputMask


getOutputMask() -> int :
    Get output mask

    C++ signature :
        unsigned long getOutputMask()

Function getParam


getParam( (str)arg1) -> typedVar :
    Get the function argument by name

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> getParam(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function getParams


getParams() -> list :
    Get list of function arguments as list of tuple (name, value ) 

    C++ signature :
        class boost::python::list getParams()

Function getProcessExeName


getProcessExeName([  (int)Id]) -> str :
    Return name of executable file of the process

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > getProcessExeName([ unsigned long])

Function getProcessId


getProcessId( (int)arg1) -> int :
    Return process ID by index

    C++ signature :
        unsigned long getProcessId(unsigned long)

Function getProcessIdBySystemID


getProcessIdBySystemID( (int)arg1) -> int :
    Return process ID by the system's process ID ( PID )

    C++ signature :
        unsigned long getProcessIdBySystemID(unsigned long)

Function getProcessOffset


getProcessOffset([  (int)Id]) -> int :
    Return the location in the target's memory of the process structure ( PEB )

    C++ signature :
        unsigned __int64 getProcessOffset([ unsigned long])

Function getProcessSystemID


getProcessSystemID([  (int)Id]) -> int :
    Return system process ID ( PID )

    C++ signature :
        unsigned long getProcessSystemID([ unsigned long])

Function getProcessThreads


getProcessThreads() -> list :
    Get all process's threads 

    C++ signature :
        class boost::python::list getProcessThreads()

Function getRegisterName


getRegisterName( (int)arg1) -> str :
    Return register name by its index

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > getRegisterName(unsigned long)

Function getSP


getSP() -> int :
    Return stack pointer

    C++ signature :
        unsigned __int64 getSP()

Function getSourceFile


getSourceFile([  (int)offset]) -> str :
    Return source file by the specified offset

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > getSourceFile([ unsigned __int64])

Function getSourceFileFromSrcSrv


getSourceFileFromSrcSrv([  (int)offset]) -> str :
    Load and return source file from source server by the specified offset

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > getSourceFileFromSrcSrv([ unsigned __int64])

Function getSourceLine


getSourceLine([  (int)offset]) -> tuple :
    Return source file name, line and displacement by the specified offset

    C++ signature :
        class boost::python::tuple getSourceLine([ unsigned __int64])

Function getSrcPath


getSrcPath() -> str :
    Return current source server path

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > getSrcPath()

Function getStack


getStack([  (bool)inlineFrames]) -> list :
    Return a current stack as a list of stackFrame objects

    C++ signature :
        class boost::python::list getStack([ bool])

Function getSymbolPath


getSymbolPath() -> str :
    Returns current symbol path

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > getSymbolPath()

Function getSymbolProviderFromSource


getSymbolProviderFromSource( (str)sourceCode [, (str)compileOptions]) -> symbolProvider :
    Create symbol provider for source code

    C++ signature :
        class boost::shared_ptr<class kdlib::SymbolProvider> getSymbolProviderFromSource(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >])

Function getSystemVersion


getSystemVersion() -> systemVersion :
    Return systemVersion

    C++ signature :
        struct kdlib::SystemInfo getSystemVersion()

Function getTargetProcesses


getTargetProcesses() -> list :
    Get all target processes 

    C++ signature :
        class boost::python::list getTargetProcesses()

Function getThreadId


getThreadId( (int)arg1) -> int :
    Return thread id by index

    C++ signature :
        unsigned long getThreadId(unsigned long)

Function getThreadIdByOffset


getThreadIdByOffset( (int)arg1) -> int :
    Return thread ID by the location in the targ et's memory of the thread structure

    C++ signature :
        unsigned long getThreadIdByOffset(unsigned __int64)

Function getThreadIdBySystemID


getThreadIdBySystemID([  (int)Tid]) -> int :
    Return thread ID by the system's thread ID ( TID )

    C++ signature :
        unsigned long getThreadIdBySystemID([ unsigned long])

Function getThreadOffset


getThreadOffset([  (int)Id]) -> int :
    Return the location in the target's memory of the thread structure ( TEB )

    C++ signature :
        unsigned __int64 getThreadOffset([ unsigned long])

Function getThreadSystemID


getThreadSystemID([  (int)Id]) -> int :
    Return system thread ID ( TID )

    C++ signature :
        unsigned long getThreadSystemID([ unsigned long])

Function getTypeFromSource


getTypeFromSource( (str)sourceCode, (str)typeName [, (str)compileOptions]) -> typeInfo :
    Create typeInfo class from C/C++ source code

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> getTypeFromSource(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >])

Function getTypeInfoProviderFromPdb


getTypeInfoProviderFromPdb( (str)filePath [, (int)baseOffset]) -> typeInfoProvider :
    Create typeInfo provider from  pdb file

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfoProvider> getTypeInfoProviderFromPdb(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,unsigned __int64])

Function getTypeInfoProviderFromSource


getTypeInfoProviderFromSource( (str)sourceCode [, (str)compileOptions]) -> typeInfoProvider :
    Create typeInfo provider from  C/C++ source code

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfoProvider> getTypeInfoProviderFromSource(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >])

Function getVaProtect


getVaProtect( (int)arg1) -> memoryProtect :
    Return memory attributes

    C++ signature :
        enum kdlib::MemoryProtect getVaProtect(unsigned __int64)

Function go


go() -> executionStatus :
    Go debugging

    C++ signature :
        enum kdlib::ExecutionStatus go()

Function initialize


initialize() -> None :
    Initialize local debug engine, only for console mode

    C++ signature :
        void initialize()

Function is64bitSystem


is64bitSystem() -> bool :
    Check if target system has 64 address space

    C++ signature :
        bool is64bitSystem()

Function isDumpAnalyzing


isDumpAnalyzing() -> bool :
    Check if it is a dump analyzing ( not living debuggee )

    C++ signature :
        bool isDumpAnalyzing()

Function isKernelDebugging


isKernelDebugging() -> bool :
    Check if kernel dubugging is running

    C++ signature :
        bool isKernelDebugging()

Function isLocalKernelDebuggerEnabled


isLocalKernelDebuggerEnabled() -> bool :
    Check whether kernel debugging is enabled for the local kernel

    C++ signature :
        bool isLocalKernelDebuggerEnabled()

Function isVaRegionValid


isVaRegionValid( (int)arg1, (int)arg2) -> bool :
    Check if the virtaul addresses region is valid

    C++ signature :
        bool isVaRegionValid(unsigned __int64,unsigned long)

Function isValid


isValid( (int)arg1) -> bool :
    Check if the virtual address is valid

    C++ signature :
        bool isValid(unsigned __int64)

Function isWindbgExt


isWindbgExt() -> bool :
    Check if script works in windbg context

    C++ signature :
        bool isWindbgExt()

Function killAllProcesses


killAllProcesses() -> None :
    Detach from all process then terminate them

    C++ signature :
        void killAllProcesses()

Function killProcess


killProcess([  (int)id]) -> None :
    Stop debugging and terminate current process

    C++ signature :
        void killProcess([ unsigned long])

Function loadAnsiString


loadAnsiString( (int)arg1) -> str :
    Return string represention of windows ANSI_STRING type

    C++ signature :
        class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > loadAnsiString(unsigned __int64)

Function loadBytes


loadBytes( (int)offset, (int)count [, (bool)phyAddr]) -> list :
    Read the block of the target's memory and return it as list of unsigned bytes

    C++ signature :
        class boost::python::list loadBytes(unsigned __int64,unsigned long [,bool])

Function loadCStr


loadCStr( (int)arg1) -> str :
    Load string from the target buffer containing 0-terminated ansi-string

    C++ signature :
        class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > loadCStr(unsigned __int64)

Function loadChars


loadChars( (int)address, (int)count [, (bool)phyAddr]) -> str :
    Load string from target memory

    C++ signature :
        class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > loadChars(unsigned __int64,unsigned long [,bool])

Function loadDWords


loadDWords( (int)offset, (int)count [, (bool)phyAddr]) -> list :
    Read the block of the target's memory and return it as list of unsigned long ( double word )

    C++ signature :
        class boost::python::list loadDWords(unsigned __int64,unsigned long [,bool])

Function loadDoubles


loadDoubles( (int)offset, (int)count [, (bool)phyAddr]) -> list :
    Read the block of the target's memory and return it as list of doubles

    C++ signature :
        class boost::python::list loadDoubles(unsigned __int64,unsigned long [,bool])

Function loadDump


loadDump( (str)arg1) -> int :
    Load crash dump

    C++ signature :
        unsigned long loadDump(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function loadExt


loadExt( (str)arg1) -> int :
    Load a WinDBG extension. Return handle of the loaded extension

    C++ signature :
        unsigned __int64 loadExt(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function loadFloats


loadFloats( (int)offset, (int)count [, (bool)phyAddr]) -> list :
    Read the block of the target's memory and return it as list of floats

    C++ signature :
        class boost::python::list loadFloats(unsigned __int64,unsigned long [,bool])

Function loadPtrList


loadPtrList( (int)arg1) -> list :
    Return list of pointers, each points to next

    C++ signature :
        class boost::python::list loadPtrList(unsigned __int64)

Function loadPtrs


loadPtrs( (int)arg1, (int)arg2) -> list :
    Read the block of the target's memory and return it as a list of pointers

    C++ signature :
        class boost::python::list loadPtrs(unsigned __int64,unsigned long)

Function loadQWords


loadQWords( (int)offset, (int)count [, (bool)phyAddr]) -> list :
    Read the block of the target's memory and return it as list of unsigned long long ( quad word )

    C++ signature :
        class boost::python::list loadQWords(unsigned __int64,unsigned long [,bool])

Function loadSignBytes


loadSignBytes( (int)offset, (int)count [, (bool)phyAddr]) -> list :
    Read the block of the target's memory and return it as list of signed bytes

    C++ signature :
        class boost::python::list loadSignBytes(unsigned __int64,unsigned long [,bool])

Function loadSignDWords


loadSignDWords( (int)offset, (int)count [, (bool)phyAddr]) -> list :
    Read the block of the target's memory and return it as list of signed longs

    C++ signature :
        class boost::python::list loadSignDWords(unsigned __int64,unsigned long [,bool])

Function loadSignQWords


loadSignQWords( (int)offset, (int)count [, (bool)phyAddr]) -> list :
    Read the block of the target's memory and return it as list of signed long longs

    C++ signature :
        class boost::python::list loadSignQWords(unsigned __int64,unsigned long [,bool])

Function loadSignWords


loadSignWords( (int)offset, (int)count [, (bool)phyAddr]) -> list :
    Read the block of the target's memory and return it as list of signed words

    C++ signature :
        class boost::python::list loadSignWords(unsigned __int64,unsigned long [,bool])

Function loadTaggedBuffer


loadTaggedBuffer( (str)arg1) -> list :
    Read the buffer of secondary callback data by ID

    C++ signature :
        class boost::python::list loadTaggedBuffer(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function loadUnicodeString


loadUnicodeString( (int)arg1) -> str :
    Return string represention of windows UNICODE_STRING type

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > loadUnicodeString(unsigned __int64)

Function loadWChars


loadWChars( (int)address, (int)count [, (bool)phyAddr]) -> str :
    Load string from target memory

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > loadWChars(unsigned __int64,unsigned long [,bool])

Function loadWStr


loadWStr( (int)arg1) -> str :
    Load string from the target buffer containing 0-terminated unicode-string

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > loadWStr(unsigned __int64)

Function loadWords


loadWords( (int)offset, (int)count [, (bool)phyAddr]) -> list :
    Read the block of the target's memory and return it as list of unsigned shorts

    C++ signature :
        class boost::python::list loadWords(unsigned __int64,unsigned long [,bool])

Function pageSize


pageSize() -> int :
    Get the page size for the currently executing processor context

    C++ signature :
        unsigned __int64 pageSize()

Function popStack


popStack() -> object :
    Pop a value from a stack

    C++ signature :
        class kdlib::NumVariant popStack()

Function ptrByte


ptrByte( (int)arg1) -> int :
    Read an unsigned 1-byte integer from the target memory

    C++ signature :
        unsigned char ptrByte(unsigned __int64)

Function ptrDWord


ptrDWord( (int)arg1) -> int :
    Read an unsigned 4-byte integer from the target memory

    C++ signature :
        unsigned long ptrDWord(unsigned __int64)

Function ptrDouble


ptrDouble( (int)arg1) -> float :
    Read a float with single precision from the target memory

    C++ signature :
        double ptrDouble(unsigned __int64)

Function ptrFloat


ptrFloat( (int)arg1) -> float :
    Read a float with single precision from the target memory

    C++ signature :
        float ptrFloat(unsigned __int64)

Function ptrMWord


ptrMWord( (int)arg1) -> int :
    Read an unsigned mashine's word wide integer from the target memory

    C++ signature :
        unsigned __int64 ptrMWord(unsigned __int64)

Function ptrPtr


ptrPtr( (int)arg1) -> int :
    Read an pointer value from the target memory

    C++ signature :
        unsigned __int64 ptrPtr(unsigned __int64)

Function ptrQWord


ptrQWord( (int)arg1) -> int :
    Read an unsigned 8-byte integer from the target memory

    C++ signature :
        unsigned __int64 ptrQWord(unsigned __int64)

Function ptrSignByte


ptrSignByte( (int)arg1) -> int :
    Read an signed 1-byte integer from the target memory

    C++ signature :
        int ptrSignByte(unsigned __int64)

Function ptrSignDWord


ptrSignDWord( (int)arg1) -> int :
    Read an signed 4-byte integer from the target memory

    C++ signature :
        long ptrSignDWord(unsigned __int64)

Function ptrSignMWord


ptrSignMWord( (int)arg1) -> int :
    Read an signed mashine's word wide integer from the target memory

    C++ signature :
        __int64 ptrSignMWord(unsigned __int64)

Function ptrSignQWord


ptrSignQWord( (int)arg1) -> int :
    Read an signed 8-byte integer from the target memory

    C++ signature :
        __int64 ptrSignQWord(unsigned __int64)

Function ptrSignWord


ptrSignWord( (int)arg1) -> int :
    Read an signed 2-byte integer from the target memory

    C++ signature :
        short ptrSignWord(unsigned __int64)

Function ptrSize


ptrSize() -> int :
    Return effective pointer size

    C++ signature :
        unsigned __int64 ptrSize()

Function ptrWord


ptrWord( (int)arg1) -> int :
    Read an unsigned 2-byte integer from the target memory

    C++ signature :
        unsigned short ptrWord(unsigned __int64)

Function pushStack


pushStack( (object)arg1) -> None :
    Push a value into a stack

    C++ signature :
        void pushStack(class kdlib::NumVariant)

Function rdmsr


rdmsr( (int)arg1) -> int :
    Return MSR value

    C++ signature :
        unsigned __int64 rdmsr(unsigned long)

Function reg


reg( (str)arg1) -> object :
    Return a CPU regsiter value by the register's name

    C++ signature :
        class boost::python::api::object reg(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

reg( (int)arg1) -> object :
    Return a CPU register value by the register's number

    C++ signature :
        class boost::python::api::object reg(unsigned long)

Function remoteConnect


remoteConnect( (str)arg1) -> None :
    Initialize debug engine for remoting, only for console mode

    C++ signature :
        void remoteConnect(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function removeAllBp


removeAllBp() -> None :
    Remove all breakpoints

    C++ signature :
        void removeAllBp()

Function removeBp


removeBp( (int)arg1) -> None :
    Remove breakpoint by index

    C++ signature :
        void removeBp(unsigned long)

Function removeExt


removeExt( (int)arg1) -> None :
    Unload a WinDBG extension. Parameter: handle returned by loadExt

    C++ signature :
        void removeExt(unsigned __int64)

removeExt( (str)arg1) -> None :
    Unload a WinDBG extension. Parameter: extension path

    C++ signature :
        void removeExt(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function removeSyntheticModule


removeSyntheticModule( (int)arg1) -> None :
    The removeSyntheticModule function removes a synthetic module from the module list the debugger maintains for the current process

    C++ signature :
        void removeSyntheticModule(unsigned __int64)

Function removeSyntheticSymbol


removeSyntheticSymbol( (syntheticSymbol)arg1) -> None :
    The removeSyntheticSymbol function removes a synthetic symbol from a module in the current proces

    C++ signature :
        void removeSyntheticSymbol(struct kdlib::SyntheticSymbol)

Function resetFrame


resetFrame() -> None :
    Resets the current local scope to the default scope of the current thread

    C++ signature :
        void resetFrame()

Function searchMemory


searchMemory( (int)arg1, (int)arg2, (list)arg3) -> int :
    Search in virtual memory

    C++ signature :
        unsigned __int64 searchMemory(unsigned __int64,unsigned long,class boost::python::list)

searchMemory( (int)arg1, (int)arg2, (str)arg3) -> int :
    Search in virtual memory

    C++ signature :
        unsigned __int64 searchMemory(unsigned __int64,unsigned long,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >)

Function setBp


setBp( (int)offset [, (object)callback]) -> breakpoint :
    Set software breakpoint on executiont

    C++ signature :
        class pykd::Breakpoint * __ptr64 setBp(unsigned __int64 [,class boost::python::api::object {lvalue}])

setBp( (int)offset, (int)size, (int)accsessType [, (object)callback]) -> breakpoint :
    Set hardware breakpoint

    C++ signature :
        class pykd::Breakpoint * __ptr64 setBp(unsigned __int64,unsigned __int64,unsigned long [,class boost::python::api::object {lvalue}])

Function setByte


setByte( (int)arg1, (int)arg2) -> None :
    Write an unsigned 1-byte integer to the target memory

    C++ signature :
        void setByte(unsigned __int64,unsigned char)

Function setCPUMode


setCPUMode( (CPUType)arg1) -> None :
    Set current processor mode (CPUType)

    C++ signature :
        void setCPUMode(enum kdlib::CPUType)

Function setCurrentProcess


setCurrentProcess( (int)arg1) -> None :
    Set current process

    C++ signature :
        void setCurrentProcess(unsigned __int64)

Function setCurrentProcessId


setCurrentProcessId( (int)arg1) -> None :
    Set current process by debug ID

    C++ signature :
        void setCurrentProcessId(unsigned long)

Function setCurrentThread


setCurrentThread( (int)arg1) -> None :
    Set current thread

    C++ signature :
        void setCurrentThread(unsigned __int64)

Function setCurrentThreadId


setCurrentThreadId( (int)arg1) -> None :
    Set current thread by debug ID

    C++ signature :
        void setCurrentThreadId(unsigned long)

Function setDWord


setDWord( (int)arg1, (int)arg2) -> None :
    Write an unsigned 4-byte integer to the target memory

    C++ signature :
        void setDWord(unsigned __int64,unsigned long)

Function setDouble


setDouble( (int)arg1, (float)arg2) -> None :
    Write a float with single precision to the target memory

    C++ signature :
        void setDouble(unsigned __int64,double)

Function setFP


setFP( (int)arg1) -> None :
    Change frame pointer

    C++ signature :
        void setFP(unsigned __int64)

Function setFloat


setFloat( (int)arg1, (float)arg2) -> None :
    Write a float with single precision to the target memory

    C++ signature :
        void setFloat(unsigned __int64,float)

Function setFrame


setFrame( (stackFrame)arg1) -> None :
    Change current local scope

    C++ signature :
        void setFrame(class boost::shared_ptr<class kdlib::StackFrame> {lvalue})

setFrame( (int)arg1) -> None :
    Change current local scope

    C++ signature :
        void setFrame(unsigned long)

Function setIP


setIP( (int)arg1) -> None :
    Change instruction pointer

    C++ signature :
        void setIP(unsigned __int64)

Function setImplicitProcess


setImplicitProcess( (int)arg1) -> None :
    Set implicit process

    C++ signature :
        void setImplicitProcess(unsigned __int64)

Function setImplicitThread


setImplicitThread( (int)arg1) -> None :
    Set implicit thread

    C++ signature :
        void setImplicitThread(unsigned __int64)

Function setOutputMask


setOutputMask( (int)arg1) -> None :
    Set output mask

    C++ signature :
        void setOutputMask(unsigned long)

Function setPtr


setPtr( (int)arg1, (int)arg2) -> None :
    Write an pointer value to the target memory

    C++ signature :
        void setPtr(unsigned __int64,unsigned __int64)

Function setQWord


setQWord( (int)arg1, (int)arg2) -> None :
    Write an unsigned 8-byte integer to the target memory

    C++ signature :
        void setQWord(unsigned __int64,unsigned __int64)

Function setReg


setReg( (str)arg1, (object)arg2) -> None :
    Set a CPU register value by its name

    C++ signature :
        void setReg(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class boost::python::api::object)

setReg( (int)arg1, (object)arg2) -> None :
    Set a CPU register value by its index

    C++ signature :
        void setReg(unsigned long,class boost::python::api::object)

Function setSP


setSP( (int)arg1) -> None :
    Change stack pointer

    C++ signature :
        void setSP(unsigned __int64)

Function setSignByte


setSignByte( (int)arg1, (int)arg2) -> None :
    Write an signed 1-byte integer to the target memory

    C++ signature :
        void setSignByte(unsigned __int64,int)

Function setSignDWord


setSignDWord( (int)arg1, (int)arg2) -> None :
    Write an signed 4-byte integer to the target memory

    C++ signature :
        void setSignDWord(unsigned __int64,long)

Function setSignQWord


setSignQWord( (int)arg1, (int)arg2) -> None :
    Write an signed 8-byte integer to the target memory

    C++ signature :
        void setSignQWord(unsigned __int64,__int64)

Function setSignWord


setSignWord( (int)arg1, (int)arg2) -> None :
    Write an signed 2-byte integer to the target memory

    C++ signature :
        void setSignWord(unsigned __int64,short)

Function setSrcPath


setSrcPath( (str)arg1) -> None :
    Set source path

    C++ signature :
        void setSrcPath(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function setStatusMessage


setStatusMessage( (str)arg1) -> None :
    Set message at a windbg status bar

    C++ signature :
        void setStatusMessage(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function setSymSrvDir


setSymSrvDir( (str)arg1) -> None :
    Set directory of SYMSRV.dll library.
    Usually this is a directory of WinDbg

    C++ signature :
        void setSymSrvDir(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function setSymbolPath


setSymbolPath( (str)arg1) -> None :
    Set current symbol path

    C++ signature :
        void setSymbolPath(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function setWord


setWord( (int)arg1, (int)arg2) -> None :
    Write an unsigned 2-byte integer to the target memory

    C++ signature :
        void setWord(unsigned __int64,unsigned short)

Function sizeof


sizeof( (str)arg1) -> int :
    Return a size of the type or variable

    C++ signature :
        unsigned __int64 sizeof(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function sourceStep


sourceStep() -> executionStatus :
    The target is executing a single source line

    C++ signature :
        enum kdlib::ExecutionStatus sourceStep()

Function sourceStepOver


sourceStepOver() -> executionStatus :
    The target is executing a single source line

    C++ signature :
        enum kdlib::ExecutionStatus sourceStepOver()

Function stackAlloc


stackAlloc( (int)arg1) -> int :
    Allocate bytes of space in the stack in the target process

    C++ signature :
        unsigned __int64 stackAlloc(unsigned short)

Function stackFree


stackFree( (int)arg1) -> int :
    Free space in the stack previously allocated by stackAlloc

    C++ signature :
        unsigned __int64 stackFree(unsigned short)

Function startProcess


startProcess( (str)commandline [, (int)debugOptions]) -> int :
    Start process for debugging

    C++ signature :
        unsigned long startProcess(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,unsigned long])

Function step


step() -> executionStatus :
    The target is executing a single instruction or--if that instruction is a subroutine call--subroutine

    C++ signature :
        enum kdlib::ExecutionStatus step()

Function stepout


stepout() -> executionStatus :
    The traget is executing while not returned from the current subroutine

    C++ signature :
        enum kdlib::ExecutionStatus stepout()

Function switchCPUMode


switchCPUMode() -> None :
    Switch processor mode ( X86 <-> X64 )

    C++ signature :
        void switchCPUMode()

Function systemUptime


systemUptime() -> int :
    Return the number of seconds the computer has been running

    C++ signature :
        unsigned long systemUptime()

Function trace


trace() -> executionStatus :
    The target is executing a single instruction

    C++ signature :
        enum kdlib::ExecutionStatus trace()

Function typedVarArray


typedVarArray( (int)arg1, (str)arg2, (int)arg3) -> list :
    Return a list of the typedVar class instances. Each item represents an item of the counted array in the target memory

    C++ signature :
        class boost::python::list typedVarArray(unsigned __int64,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,unsigned __int64)

typedVarArray( (int)arg1, (typeInfo)arg2, (int)arg3) -> list :
    Return a list of the typedVar class instances. Each item represents an item of the counted array in the target memory

    C++ signature :
        class boost::python::list typedVarArray(unsigned __int64,class boost::shared_ptr<class kdlib::TypeInfo> {lvalue},unsigned __int64)

Function typedVarList


typedVarList( (int)arg1, (str)arg2, (str)arg3) -> list :
    Return a list of the typedVar class instances. Each item represents an item of the linked list in the target memory

    C++ signature :
        class boost::python::list typedVarList(unsigned __int64,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

typedVarList( (int)arg1, (typeInfo)arg2, (str)arg3) -> list :
    Return a list of the typedVar class instances. Each item represents an item of the linked list in the target memory

    C++ signature :
        class boost::python::list typedVarList(unsigned __int64,class boost::shared_ptr<class kdlib::TypeInfo> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function writeBytes


writeBytes( (int)offset, (list)values [, (bool)phyAddr]) -> None :
    Writing a list of unsigned bytes to the target's memory

    C++ signature :
        void writeBytes(unsigned __int64,class boost::python::list [,bool])

Function writeCStr


writeCStr( (int)arg1, (str)arg2) -> None :
    Write string as a 0 terminated ansi string to the buffer

    C++ signature :
        void writeCStr(unsigned __int64,class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >)

Function writeDWords


writeDWords( (int)offset, (list)values [, (bool)phyAddr]) -> None :
    Writing a list of unsigned long ( double word ) to the target's memory

    C++ signature :
        void writeDWords(unsigned __int64,class boost::python::list [,bool])

Function writeDoubles


writeDoubles( (int)offset, (list)values [, (bool)phyAddr]) -> None :
    Writing a list of doubles to the target's memory

    C++ signature :
        void writeDoubles(unsigned __int64,class boost::python::list [,bool])

Function writeDump


writeDump( (str)arg1, (bool)arg2) -> None :
    Create memory dump file

    C++ signature :
        void writeDump(class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,bool)

Function writeFloats


writeFloats( (int)offset, (list)values [, (bool)phyAddr]) -> None :
    Writing a list of floats to the target's memory

    C++ signature :
        void writeFloats(unsigned __int64,class boost::python::list [,bool])

Function writeQWords


writeQWords( (int)offset, (list)values [, (bool)phyAddr]) -> None :
    Writing a list of unsigned long long ( quad word ) to the target's memory

    C++ signature :
        void writeQWords(unsigned __int64,class boost::python::list [,bool])

Function writeSignBytes


writeSignBytes( (int)offset, (list)values [, (bool)phyAddr]) -> None :
    Writing a list of signed bytes to the target's memory

    C++ signature :
        void writeSignBytes(unsigned __int64,class boost::python::list [,bool])

Function writeSignDWords


writeSignDWords( (int)offset, (list)values [, (bool)phyAddr]) -> None :
    Writing a list of signed longs to the target's memory

    C++ signature :
        void writeSignDWords(unsigned __int64,class boost::python::list [,bool])

Function writeSignQWords


writeSignQWords( (int)offset, (list)values [, (bool)phyAddr]) -> None :
    Writing a list of signed long longs to the target's memory

    C++ signature :
        void writeSignQWords(unsigned __int64,class boost::python::list [,bool])

Function writeSignWords


writeSignWords( (int)offset, (list)count [, (bool)phyAddr]) -> None :
    Writing a list of signed words to the target's memory

    C++ signature :
        void writeSignWords(unsigned __int64,class boost::python::list [,bool])

Function writeWStr


writeWStr( (int)arg1, (str)arg2) -> None :
    Write string as a 0 terminated unicode string to the buffer

    C++ signature :
        void writeWStr(unsigned __int64,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Function writeWords


writeWords( (int)offset, (list)values [, (bool)phyAddr]) -> None :
    Writing a list of unsigned shorts to the target's memory

    C++ signature :
        void writeWords(unsigned __int64,class boost::python::list [,bool])

Function wrmsr


wrmsr( (int)arg1, (int)arg2) -> None :
    Set MSR value

    C++ signature :
        void wrmsr(unsigned long,unsigned __int64)

Class CPUException

CPU exception

Base classes:

DbgException

Class CPUType

type of CPU

Base classes:

enum

Values:

  • I386: 0
  • AMD64: 1
  • ARM64: 2
  • ARM: 3

Class CallException

Function call exception

Base classes:

DbgException

Class DbgException

Pykd base exception class

Base classes:

Exception

Class FileFlag

Attributes of the file

Base classes:

enum

Values:

  • Debug: 1
  • PreRelease: 2
  • Patched: 4
  • PrivateBuild: 8
  • InfoInferred: 16
  • SpecialBuild: 32

Class FixedFileInfo

Version information for a file

Base classes:

instance

Properties:

  • FileDateLS
  • FileDateMS
  • FileFlags
  • FileFlagsMask
  • FileOS
  • FileSubtype
  • FileType
  • FileVersionLS
  • FileVersionMS
  • ProductVersionLS
  • ProductVersionMS
  • Signature
  • StrucVersion

Property FixedFileInfo.FileDateLS

The least significant 32 bits of the file's 64-bit binary creation date and time stamp

Property FixedFileInfo.FileDateMS

The most significant 32 bits of the file's 64-bit binary creation date and time stamp

Property FixedFileInfo.FileFlags

Contains a bitmask that specifies the Boolean attributes of the file: FileFlag

Property FixedFileInfo.FileFlagsMask

Contains a bitmask that specifies the valid bits in FileFlags

Property FixedFileInfo.FileOS

The operating system for which this file was designed

Property FixedFileInfo.FileSubtype

The function of the file. The possible values depend on the value of FileType

Property FixedFileInfo.FileType

The general type of file

Property FixedFileInfo.FileVersionLS

The least significant 32 bits of the file's binary version number

Property FixedFileInfo.FileVersionMS

The most significant 32 bits of the file's binary version number

Property FixedFileInfo.ProductVersionLS

The least significant 32 bits of the binary version number of the product with which this file was distributed

Property FixedFileInfo.ProductVersionMS

The most significant 32 bits of the binary version number of the product with which this file was distributed

Property FixedFileInfo.Signature

Contains the value 0xFEEF04BD

Property FixedFileInfo.StrucVersion

The binary version number of this structure

Class Location

Location of a varibale

Base classes:

enum

Values:

  • Reg: 2
  • Memory: 1

Class MemoryException

Target memory access exception class

Base classes:

DbgException

Class ProcessDebugOptions

Process debug option

Base classes:

enum

Values:

  • BreakOnStart: 1
  • BreakOnStop: 2
  • DebugChildren: 4
  • NoDebugHeap: 8
  • Deafult: 1

Class SymbolException

Symbol exception

Base classes:

DbgException

Class TypeException

type exception

Base classes:

SymbolException

Class baseTypes

base types enumeration

Base classes:

instance

Class breakpoint

class for CPU context representation

Base classes:

instance

Methods:

  • __init__
  • detach
  • getId
  • getOffset
  • onHit
  • remove

Method breakpoint.__init__


__init__( (object)arg1, (int)arg2) -> None :

    C++ signature :
        void __init__(struct _object * __ptr64,unsigned __int64)

__init__( (object)arg1, (int)arg2, (int)arg3, (int)arg4) -> None :

    C++ signature :
        void __init__(struct _object * __ptr64,unsigned __int64,unsigned __int64,unsigned long)

Method breakpoint.detach


detach( (breakpoint)arg1) -> breakpoint :
    detach breakpoint

    C++ signature :
        class pykd::Breakpoint * __ptr64 detach(class pykd::Breakpoint {lvalue})

Method breakpoint.getId


getId( (breakpoint)arg1) -> int :
    Return breakpoint ID

    C++ signature :
        unsigned long getId(class pykd::Breakpoint {lvalue})

Method breakpoint.getOffset


getOffset( (breakpoint)arg1) -> int :
    Return breakpoint's memory offset

    C++ signature :
        unsigned __int64 getOffset(class pykd::Breakpoint {lvalue})

Method breakpoint.onHit


onHit( (breakpoint)arg1) -> eventResult :
    Breakpoint hit callback

    C++ signature :
        enum kdlib::DebugCallbackResult onHit(class pykd::Breakpoint {lvalue})

Method breakpoint.remove


remove( (breakpoint)arg1) -> None :
    Remove breakpoint

    C++ signature :
        void remove(class pykd::Breakpoint {lvalue})

Class breakpointAccess

Breakpoint access types

Base classes:

enum

Values:

  • Read: 1
  • Write: 2
  • Execute: 4

Class callingConvention

Calling convention for a function

Base classes:

enum

Values:

  • NearC: 0
  • FarC: 1
  • NearPascal: 2
  • FarPascal: 3
  • NearFast: 4
  • FarFast: 5
  • Skipped: 6
  • NearStd: 7
  • FarStd0: 8
  • NearSys: 9
  • FarSys: 10
  • ThisCall: 11
  • MipsCall: 12
  • Generic: 13
  • AlphaCall : 14
  • PpcCall: 15
  • ShCall: 16
  • ArmCall: 17
  • Am33Call: 18
  • TriCall: 19
  • Sh5Call: 20
  • M32RCall: 21
  • ClrCall: 22
  • Inline: 23

Class cpu

class for CPU context representation

Base classes:

instance

Properties:

  • fp
  • ip
  • sp

Methods:

  • __getattr__
  • __getitem__
  • __init__
  • __len__
  • getCPUMode
  • getCPUType

Method cpu.__getattr__


__getattr__( (cpu)arg1, (str)arg2) -> object :

    C++ signature :
        class boost::python::api::object __getattr__(class pykd::CPUContextAdapter {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method cpu.__getitem__


__getitem__( (cpu)arg1, (int)arg2) -> tuple :

    C++ signature :
        class boost::python::tuple __getitem__(class pykd::CPUContextAdapter {lvalue},unsigned long)

Method cpu.__init__


__init__( (object)arg1) -> None :

    C++ signature :
        void __init__(struct _object * __ptr64)

Method cpu.__len__


__len__( (cpu)arg1) -> int :

    C++ signature :
        unsigned long __len__(class pykd::CPUContextAdapter {lvalue})

Method cpu.getCPUMode


getCPUMode( (cpu)arg1) -> CPUType :

    C++ signature :
        enum kdlib::CPUType getCPUMode(class pykd::CPUContextAdapter {lvalue})

Method cpu.getCPUType


getCPUType( (cpu)arg1) -> CPUType :

    C++ signature :
        enum kdlib::CPUType getCPUType(class pykd::CPUContextAdapter {lvalue})

Class debugEvent

Debug evemt descriptions

Base classes:

instance

Properties:

  • process
  • thread
  • type

Class debugOptions

Debug options

Base classes:

enum

Values:

  • AllowNetworkPaths: 4
  • DisallowNetworkPaths: 8
  • InitialBreak: 32
  • FinalBreak: 64
  • FailIncompleteInformation: 512
  • DisableModuleSymbolLoad: 32768
  • DisallowImageFileMapping: 131072
  • PreferDml: 262144

Class din

din

Base classes:

instance

Properties:

  • closed
  • encoding

Methods:

  • readline

Method din.readline


readline( (din)arg1) -> str :

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > readline(class pykd::DbgIn {lvalue})

Class disasm

Class disassemble a processor instructions

Base classes:

instance

Methods:

  • __init__
  • __str__
  • asm
  • begin
  • current
  • disasm
  • ea
  • findOffset
  • instruction
  • jump
  • jumprel
  • length
  • opcode
  • opmnemo
  • reset

Method disasm.__init__


__init__( (object)arg1) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object)

__init__( (object)arg1, (int)arg2) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object,unsigned __int64)

Method disasm.__str__


__str__( (disasm)arg1) -> str :

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(class kdlib::Disasm {lvalue})

Method disasm.asm


asm( (disasm)arg1, (str)arg2) -> str :
    Insert assemblied instuction to current offset

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > asm(class kdlib::Disasm {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method disasm.begin


begin( (disasm)arg1) -> int :
    Return begin offset

    C++ signature :
        unsigned __int64 begin(class kdlib::Disasm {lvalue})

Method disasm.current


current( (disasm)arg1) -> int :
    Return current offset

    C++ signature :
        unsigned __int64 current(class kdlib::Disasm {lvalue})

Method disasm.disasm


disasm( (disasm)arg1) -> str :
    Disassemble next instruction

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > disasm(class kdlib::Disasm {lvalue})

disasm( (disasm)arg1, (int)arg2) -> str :
    Disassemble from the specified offset

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > disasm(class kdlib::Disasm {lvalue},unsigned __int64)

Method disasm.ea


ea( (disasm)arg1) -> int :
    Return effective address for last disassembled instruction or 0

    C++ signature :
        unsigned __int64 ea(class kdlib::Disasm {lvalue})

Method disasm.findOffset


findOffset( (disasm)arg1, (int)arg2) -> int :
    Return the location of a processor instruction relative to a given location

    C++ signature :
        unsigned __int64 findOffset(class kdlib::Disasm {lvalue},long)

Method disasm.instruction


instruction( (disasm)arg1) -> str :
    Returm current disassembled instruction

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > instruction(class kdlib::Disasm {lvalue})

Method disasm.jump


jump( (disasm)arg1, (int)arg2) -> str :
    Change the current instruction

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > jump(class kdlib::Disasm {lvalue},unsigned __int64)

Method disasm.jumprel


jumprel( (disasm)arg1, (int)arg2) -> str :
    Change the current instruction

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > jumprel(class kdlib::Disasm {lvalue},long)

Method disasm.length


length( (disasm)arg1) -> int :
    Return current instruction length

    C++ signature :
        unsigned __int64 length(class kdlib::Disasm {lvalue})

Method disasm.opcode


opcode( (disasm)arg1) -> list :
    Return list of bytes of the instruction opcode

    C++ signature :
        class boost::python::list opcode(class kdlib::Disasm {lvalue})

Method disasm.opmnemo


opmnemo( (disasm)arg1) -> str :
    Return mnemocode of the instruction

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > opmnemo(class kdlib::Disasm {lvalue})

Method disasm.reset


reset( (disasm)arg1) -> str :
    Reset current offset to begin

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > reset(class kdlib::Disasm {lvalue})

Class dout

dout

Base classes:

instance

Properties:

  • closed
  • encoding

Methods:

  • flush
  • isatty
  • write
  • writedml

Method dout.flush


flush( (dout)arg1) -> None :

    C++ signature :
        void flush(class pykd::DbgOut {lvalue})

Method dout.isatty


isatty( (dout)arg1) -> bool :

    C++ signature :
        bool isatty(class pykd::DbgOut {lvalue})

Method dout.write


write( (dout)arg1, (str)arg2) -> None :

    C++ signature :
        void write(class pykd::DbgOut {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method dout.writedml


writedml( (dout)arg1, (str)arg2) -> None :

    C++ signature :
        void writedml(class pykd::DbgOut {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Class eventHandler

Base class for overriding and handling debug notifications

Base classes:

instance

Methods:

  • __init__
  • onBreakpoint
  • onChangeBreakpoints
  • onChangeLocalScope
  • onChangeSymbolPaths
  • onCurrentThreadChange
  • onDebugOutput
  • onException
  • onExecutionStatusChange
  • onLoadModule
  • onStartInput
  • onStopInput
  • onThreadStart
  • onThreadStop
  • onUnloadModule

Method eventHandler.__init__


__init__( (object)arg1) -> None :

    C++ signature :
        void __init__(struct _object * __ptr64)

Method eventHandler.onBreakpoint


onBreakpoint( (eventHandler)arg1, (int)arg2) -> eventResult :
    Triggered breakpoint event. Parameter is int: ID of breakpoint
    For ignore event method must return eventResult.noChange

    C++ signature :
        enum kdlib::DebugCallbackResult onBreakpoint(class pykd::EventHandler {lvalue},unsigned long)

Method eventHandler.onChangeBreakpoints


onChangeBreakpoints( (eventHandler)arg1) -> None :
    Breakpoints is changed for current process

    C++ signature :
        void onChangeBreakpoints(class pykd::EventHandler {lvalue})

Method eventHandler.onChangeLocalScope


onChangeLocalScope( (eventHandler)arg1) -> None :
    The current local scope has been changed.
    There is no return value

    C++ signature :
        void onChangeLocalScope(class pykd::EventHandler {lvalue})

Method eventHandler.onChangeSymbolPaths


onChangeSymbolPaths( (eventHandler)arg1) -> None :
    Symbol paths has been changed.
    There is no return value

    C++ signature :
        void onChangeSymbolPaths(class pykd::EventHandler {lvalue})

Method eventHandler.onCurrentThreadChange


onCurrentThreadChange( (eventHandler)arg1, (int)arg2) -> None :
    The current thread has been changed, which implies that the current target and current process might also have changed.
    There is no return value

    C++ signature :
        void onCurrentThreadChange(class pykd::EventHandler {lvalue},unsigned long)

Method eventHandler.onDebugOutput


onDebugOutput( (eventHandler)arg1, (str)arg2, (outputFlag)arg3) -> None :
    Request debug output

    C++ signature :
        void onDebugOutput(class pykd::EventHandler {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,enum kdlib::OutputFlag)

Method eventHandler.onException


onException( (eventHandler)arg1, (exceptionInfo)arg2) -> eventResult :
    Triggered exception event. Parameter - exceptionInfo
    For ignore event method must return eventResult.noChange

    C++ signature :
        enum kdlib::DebugCallbackResult onException(class pykd::EventHandler {lvalue},struct kdlib::ExceptionInfo)

Method eventHandler.onExecutionStatusChange


onExecutionStatusChange( (eventHandler)arg1, (executionStatus)arg2) -> None :
    Triggered execution status changed. Parameter - execution status.
    There is no return value

    C++ signature :
        void onExecutionStatusChange(class pykd::EventHandler {lvalue},enum kdlib::ExecutionStatus)

Method eventHandler.onLoadModule


onLoadModule( (eventHandler)arg1, (int)arg2, (str)arg3) -> eventResult :
    Triggered module load event. Parameter are long: module base, string: module name
    For ignore event method must return eventResult.noChange

    C++ signature :
        enum kdlib::DebugCallbackResult onLoadModule(class pykd::EventHandler {lvalue},unsigned __int64,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method eventHandler.onStartInput


onStartInput( (eventHandler)arg1) -> None :
    Request debug input

    C++ signature :
        void onStartInput(class pykd::EventHandler {lvalue})

Method eventHandler.onStopInput


onStopInput( (eventHandler)arg1) -> None :
    Debug input is completed

    C++ signature :
        void onStopInput(class pykd::EventHandler {lvalue})

Method eventHandler.onThreadStart


onThreadStart( (eventHandler)arg1) -> eventResult :
    New thread is started in the current process

    C++ signature :
        enum kdlib::DebugCallbackResult onThreadStart(class pykd::EventHandler {lvalue})

Method eventHandler.onThreadStop


onThreadStop( (eventHandler)arg1) -> eventResult :
    A thread is stopped in the current thread

    C++ signature :
        enum kdlib::DebugCallbackResult onThreadStop(class pykd::EventHandler {lvalue})

Method eventHandler.onUnloadModule


onUnloadModule( (eventHandler)arg1, (int)arg2, (str)arg3) -> eventResult :
    Triggered module unload event. Parameter are  long: module base, string: module name
    For ignore event method must return eventResult.noChange

    C++ signature :
        enum kdlib::DebugCallbackResult onUnloadModule(class pykd::EventHandler {lvalue},unsigned __int64,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Class eventResult

Return value of event handler

Base classes:

enum

Values:

  • Proceed: 0
  • NoChange: 1
  • Break: 2

Class eventType

Type of debug event

Base classes:

enum

Values:

  • Breakpoint: 1
  • Exception: 2
  • CreateThread: 3
  • ExitThread: 4
  • CreateProcess: 5
  • ExitProcess: 6
  • LoadModule: 7
  • UnloadModule: 8
  • SystemError: 9
  • SessionStatus: 10
  • ChangeDebuggeeState: 11
  • ChangeEngineState: 12
  • ChangeSymbolState: 13

Class exceptionInfo

Exception information

Base classes:

instance

Properties:

  • exceptionAddress
  • exceptionCode
  • exceptionFlags
  • exceptionRecord
  • firstChance
  • parameters

Methods:

  • __str__

Property exceptionInfo.exceptionAddress

The address where the exception occurred

Property exceptionInfo.exceptionCode

The reason the exception occurred

Property exceptionInfo.exceptionFlags

The exception flags

Property exceptionInfo.exceptionRecord

A pointer to an associated EXCEPTION_RECORD structure

Property exceptionInfo.firstChance

Specifies whether this exception has been previously encountered

Property exceptionInfo.parameters

An array of additional arguments that describe the exception

Method exceptionInfo.__str__


__str__( (exceptionInfo)arg1) -> str :
    Return object as a string

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(struct kdlib::ExceptionInfo {lvalue})

Class executionStatus

Execution Status

Base classes:

enum

Values:

  • NoChange: 0
  • Go: 1
  • Break: 2
  • NoDebuggee: 3

Class memoryProtect

Memory protection attribiuties

Base classes:

enum

Values:

  • PageNoAccess: 1
  • PageReadOnly: 2
  • PageReadWrite: 4
  • PageWriteCopy: 2
  • PageExecute: 16
  • PageExecuteRead: 32
  • PageExecuteReadWrite: 64
  • PageExecuteWriteCopy: 128

Class module

Class representing executable module

Base classes:

numVariant

Methods:

  • __contains__
  • __getattr__
  • __getitem__
  • __init__
  • __str__
  • begin
  • checksum
  • containingRecord
  • end
  • enumSymbols
  • enumTypes
  • findSymbol
  • findSymbolAndDisp
  • getFixedFileInfo
  • getVersion
  • hasSymbol
  • image
  • name
  • offset
  • queryVersion
  • reload
  • rva
  • size
  • sizeof
  • symfile
  • timestamp
  • type
  • typedVar
  • typedVarArray
  • typedVarList
  • um
  • unloaded

Method module.__contains__


__contains__( (module)arg1, (str)arg2) -> bool :

    C++ signature :
        bool __contains__(class boost::shared_ptr<class kdlib::Module> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.__getattr__


__getattr__( (module)arg1, (str)arg2) -> object :
    Return symbol offset or type as attribute

    C++ signature :
        class boost::python::api::object __getattr__(class kdlib::Module {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.__getitem__


__getitem__( (module)arg1, (str)arg2) -> object :
    Return symbol offset or type as item

    C++ signature :
        class boost::python::api::object __getitem__(class kdlib::Module {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.__init__


__init__( (object)arg1, (str)arg2) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

__init__( (object)arg1, (int)arg2) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object,unsigned __int64)

Method module.__str__


__str__( (module)arg1) -> str :

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(class kdlib::Module {lvalue})

Method module.begin


begin( (module)arg1) -> int :
    Return start address of the module

    C++ signature :
        unsigned __int64 begin(class kdlib::Module {lvalue})

Method module.checksum


checksum( (module)arg1) -> int :
    Return a image file checksum: IMAGE_OPTIONAL_HEADER.CheckSum

    C++ signature :
        unsigned long checksum(class kdlib::Module {lvalue})

Method module.containingRecord


containingRecord( (module)arg1, (int)arg2, (str)arg3, (str)arg4) -> typedVar :
    Return instance of the typedVar class. It's value are loaded from the target memory.The start address is calculated by the same method as the standard macro CONTAINING_RECORD does

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> containingRecord(class kdlib::Module {lvalue},unsigned __int64,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.end


end( (module)arg1) -> int :
    Return end address of the module

    C++ signature :
        unsigned __int64 end(class kdlib::Module {lvalue})

Method module.enumSymbols


enumSymbols( (module)arg1 [, (str)mask]) -> list :
    Return list of tuple ( symbolname, offset )

    C++ signature :
        class boost::python::list enumSymbols(class kdlib::Module {lvalue} [,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >])

Method module.enumTypes


enumTypes( (module)arg1 [, (str)mask]) -> list :
    Return list of types name

    C++ signature :
        class boost::python::list enumTypes(class kdlib::Module {lvalue} [,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >])

Method module.findSymbol


findSymbol( (module)arg1, (int)offset [, (bool)showDisplacement]) -> str :
    Return symbol name by virtual address

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > findSymbol(class kdlib::Module {lvalue},unsigned __int64 [,bool])

Method module.findSymbolAndDisp


findSymbolAndDisp( (module)arg1, (int)arg2) -> tuple :
    Return tuple(symbol_name, displacement) by virtual address

    C++ signature :
        class boost::python::tuple findSymbolAndDisp(class kdlib::Module {lvalue},unsigned __int64)

Method module.getFixedFileInfo


getFixedFileInfo( (module)arg1) -> FixedFileInfo :
    Return FixedFileInfo

    C++ signature :
        class boost::shared_ptr<struct kdlib::FixedFileInfo> getFixedFileInfo(class kdlib::Module {lvalue})

Method module.getVersion


getVersion( (module)arg1) -> tuple :
    Return tuple of the module's file version

    C++ signature :
        class boost::python::tuple getVersion(class kdlib::Module {lvalue})

Method module.hasSymbol


hasSymbol( (module)arg1, (str)arg2) -> bool :
    Check if a module has the specified symbol

    C++ signature :
        bool hasSymbol(class boost::shared_ptr<class kdlib::Module> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.image


image( (module)arg1) -> str :
    Return name of the image of the module

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > image(class kdlib::Module {lvalue})

Method module.name


name( (module)arg1) -> str :
    Return name of the module

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > name(class kdlib::Module {lvalue})

Method module.offset


offset( (module)arg1, (str)arg2) -> int :
    Return offset of the symbol

    C++ signature :
        unsigned __int64 offset(class kdlib::Module {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.queryVersion


queryVersion( (module)arg1, (str)arg2) -> str :
    Return string from the module's version resources

    C++ signature :
        class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > queryVersion(class kdlib::Module {lvalue},class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >)

Method module.reload


reload( (module)arg1) -> None :
    (Re)load symbols for the module

    C++ signature :
        void reload(class kdlib::Module {lvalue})

Method module.rva


rva( (module)arg1, (str)arg2) -> int :
    Return rva of the symbol

    C++ signature :
        unsigned long rva(class kdlib::Module {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.size


size( (module)arg1) -> int :
    Return size of the module

    C++ signature :
        unsigned __int64 size(class kdlib::Module {lvalue})

Method module.sizeof


sizeof( (module)arg1, (str)arg2) -> int :
    Return a size of the type or variable

    C++ signature :
        unsigned __int64 sizeof(class kdlib::Module {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.symfile


symfile( (module)arg1) -> str :
    Return the full path to the module's symbol information

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > symfile(class kdlib::Module {lvalue})

Method module.timestamp


timestamp( (module)arg1) -> int :
    Return a low 32 bits of the time stamp of the image: IMAGE_FILE_HEADER.TimeDateStamp

    C++ signature :
        unsigned long timestamp(class kdlib::Module {lvalue})

Method module.type


type( (module)arg1, (str)arg2) -> typeInfo :
    Return typeInfo class by type name

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> type(class kdlib::Module {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.typedVar


typedVar( (module)arg1, (int)arg2) -> typedVar :
    Return a typedVar class instance

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> typedVar(class kdlib::Module {lvalue},unsigned __int64)

typedVar( (module)arg1, (str)arg2) -> typedVar :
    Return a typedVar class instance

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> typedVar(class kdlib::Module {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

typedVar( (module)arg1, (str)arg2, (object)arg3) -> typedVar :
    Return a typedVar class instance

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> typedVar(class kdlib::Module {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class boost::python::api::object {lvalue})

typedVar( (module)arg1, (str)arg2, (str)arg3) -> typedVar :
    Return a typedVar class instance

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> typedVar(class kdlib::Module {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.typedVarArray


typedVarArray( (module)arg1, (int)arg2, (str)arg3, (int)arg4) -> list :
    Return a list of the typedVar class instances. Each item represents an item of the counted array in the target memory

    C++ signature :
        class boost::python::list typedVarArray(class kdlib::Module {lvalue},unsigned __int64,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,unsigned __int64)

Method module.typedVarList


typedVarList( (module)arg1, (int)arg2, (str)arg3, (str)arg4) -> list :
    Return a list of the typedVar class instances. Each item represents an item of the linked list in the target memory

    C++ signature :
        class boost::python::list typedVarList(class kdlib::Module {lvalue},unsigned __int64,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method module.um


um( (module)arg1) -> bool :
    Returns a flag that the module is a user-mode module

    C++ signature :
        bool um(class kdlib::Module {lvalue})

Method module.unloaded


unloaded( (module)arg1) -> bool :
    Returns a flag that the module was unloaded

    C++ signature :
        bool unloaded(class kdlib::Module {lvalue})

Class numVariant

numVariant

Base classes:

instance

Methods:

  • __add__
  • __and__
  • __eq__
  • __float__
  • __floordiv__
  • __ge__
  • __gt__
  • __hash__
  • __hex__
  • __index__
  • __int__
  • __invert__
  • __le__
  • __long__
  • __lshift__
  • __lt__
  • __mod__
  • __mul__
  • __ne__
  • __neg__
  • __nonzero__
  • __or__
  • __pos__
  • __radd__
  • __rand__
  • __rfloordiv__
  • __rlshift__
  • __rmod__
  • __rmul__
  • __ror__
  • __rrshift__
  • __rshift__
  • __rsub__
  • __rtruediv__
  • __rxor__
  • __str__
  • __sub__
  • __truediv__
  • __xor__
  • isInteger

Method numVariant.__add__


__add__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __add__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__and__


__and__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __and__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__eq__


__eq__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __eq__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__float__


__float__( (numVariant)arg1) -> object :

    C++ signature :
        class boost::python::api::object __float__(class kdlib::NumConvertable {lvalue})

Method numVariant.__floordiv__


__floordiv__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __floordiv__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__ge__


__ge__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __ge__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__gt__


__gt__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __gt__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__hash__


__hash__( (numVariant)arg1) -> object :

    C++ signature :
        class boost::python::api::object __hash__(class kdlib::NumConvertable {lvalue})

Method numVariant.__hex__


__hex__( (numVariant)arg1) -> str :

    C++ signature :
        class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > __hex__(class kdlib::NumConvertable {lvalue})

Method numVariant.__index__


__index__( (numVariant)arg1) -> object :

    C++ signature :
        class boost::python::api::object __index__(class kdlib::NumConvertable {lvalue})

Method numVariant.__int__


__int__( (numVariant)arg1) -> object :

    C++ signature :
        class boost::python::api::object __int__(class kdlib::NumConvertable {lvalue})

Method numVariant.__invert__


__invert__( (numVariant)arg1) -> object :

    C++ signature :
        class boost::python::api::object __invert__(class kdlib::NumConvertable {lvalue})

Method numVariant.__le__


__le__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __le__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__long__


__long__( (numVariant)arg1) -> object :

    C++ signature :
        class boost::python::api::object __long__(class kdlib::NumConvertable {lvalue})

Method numVariant.__lshift__


__lshift__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __lshift__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__lt__


__lt__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __lt__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__mod__


__mod__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __mod__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__mul__


__mul__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __mul__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__ne__


__ne__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __ne__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__neg__


__neg__( (numVariant)arg1) -> object :

    C++ signature :
        class boost::python::api::object __neg__(class kdlib::NumConvertable {lvalue})

Method numVariant.__nonzero__


__nonzero__( (numVariant)arg1) -> object :

    C++ signature :
        class boost::python::api::object __nonzero__(class kdlib::NumConvertable {lvalue})

Method numVariant.__or__


__or__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __or__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__pos__


__pos__( (numVariant)arg1) -> object :

    C++ signature :
        class boost::python::api::object __pos__(class kdlib::NumConvertable {lvalue})

Method numVariant.__radd__


__radd__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __radd__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__rand__


__rand__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __rand__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__rfloordiv__


__rfloordiv__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __rfloordiv__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__rlshift__


__rlshift__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __rlshift__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__rmod__


__rmod__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __rmod__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__rmul__


__rmul__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __rmul__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__ror__


__ror__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __ror__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__rrshift__


__rrshift__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __rrshift__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__rshift__


__rshift__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __rshift__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__rsub__


__rsub__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __rsub__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__rtruediv__


__rtruediv__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __rtruediv__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__rxor__


__rxor__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __rxor__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__str__


__str__( (numVariant)arg1) -> str :

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(class kdlib::NumConvertable {lvalue})

Method numVariant.__sub__


__sub__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __sub__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__truediv__


__truediv__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __truediv__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.__xor__


__xor__( (numVariant)arg1, (object)arg2) -> object :

    C++ signature :
        class boost::python::api::object __xor__(class kdlib::NumConvertable {lvalue},class boost::python::api::object {lvalue})

Method numVariant.isInteger


isInteger( (numVariant)arg1) -> bool :

    C++ signature :
        bool isInteger(class kdlib::NumConvertable {lvalue})

Class outputFlag

Set of output mask

Base classes:

enum

Values:

  • Normal: 1
  • Error: 2
  • Warning: 4
  • Verbose: 8
  • Prompt: 16
  • PromptRegister: 32
  • ExtensionWarning: 64
  • Debuggee: 128
  • DebuggeePrompt: 256
  • Symbols: 512
  • Status: 1024
  • All: 2047

Class stackFrame

class for stack's frame representation

Base classes:

instance

Properties:

  • fp
  • frameOffset
  • instructionOffset
  • ip
  • locals
  • params
  • ret
  • returnOffset
  • sp
  • stackOffset

Methods:

  • __str__
  • findSymbol
  • getLocal
  • getLocals
  • getParam
  • getParams
  • getSourceLine
  • isInline
  • switchTo

Property stackFrame.fp

frame pointer

Property stackFrame.frameOffset

Return a frame's offset

Property stackFrame.instructionOffset

Return a frame's instruction offset

Property stackFrame.ip

instruction pointer

Property stackFrame.locals

return a set of  function's local variables as a dict ( name : value)

Property stackFrame.params

return set of function's parameters as a dict (name : value)

Property stackFrame.ret

return pointer

Property stackFrame.returnOffset

Return a frame's return offset

Property stackFrame.sp

stack pointer

Property stackFrame.stackOffset

Return a frame's stack offset

Method stackFrame.__str__


__str__( (stackFrame)arg1) -> str :

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(class boost::shared_ptr<class kdlib::StackFrame> {lvalue})

Method stackFrame.findSymbol


findSymbol( (stackFrame)arg1) -> tuple :
    return symbol for frame's instruction pointer

    C++ signature :
        class boost::python::tuple findSymbol(class boost::shared_ptr<class kdlib::StackFrame> {lvalue})

Method stackFrame.getLocal


getLocal( (stackFrame)arg1, (str)arg2) -> typedVar :
    return the function's local variable  by it's name

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> getLocal(class boost::shared_ptr<class kdlib::StackFrame> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method stackFrame.getLocals


getLocals( (stackFrame)arg1) -> list :
    return set of function's local variables  as a  list of tuple (name, value ) 

    C++ signature :
        class boost::python::list getLocals(class boost::shared_ptr<class kdlib::StackFrame> {lvalue})

Method stackFrame.getParam


getParam( (stackFrame)arg1, (str)arg2) -> typedVar :
    return function param by it's name

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> getParam(class boost::shared_ptr<class kdlib::StackFrame> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method stackFrame.getParams


getParams( (stackFrame)arg1) -> list :
    return set of function's parameters  as a  list of tuple (name, value ) 

    C++ signature :
        class boost::python::list getParams(class boost::shared_ptr<class kdlib::StackFrame> {lvalue})

Method stackFrame.getSourceLine


getSourceLine( (stackFrame)arg1) -> tuple :
    return source line for stack frame's function

    C++ signature :
        class boost::python::tuple getSourceLine(class boost::shared_ptr<class kdlib::StackFrame> {lvalue})

Method stackFrame.isInline


isInline( (stackFrame)arg1) -> bool :
    this virtual frame of inlined function

    C++ signature :
        bool isInline(class boost::shared_ptr<class kdlib::StackFrame> {lvalue})

Method stackFrame.switchTo


switchTo( (stackFrame)arg1) -> None :
    Make this frame a current

    C++ signature :
        void switchTo(class boost::shared_ptr<class kdlib::StackFrame> {lvalue})

Class symbolIterator

Iterator for symbols

Base classes:

instance

Methods:

  • __iter__
  • __next__

Method symbolIterator.__iter__


__iter__( (object)arg1) -> object :

    C++ signature :
        class boost::python::api::object __iter__(class boost::python::api::object)

Method symbolIterator.__next__


__next__( (symbolIterator)arg1) -> tuple :

    C++ signature :
        class boost::python::tuple __next__(struct pykd::SymbolEnumeratorAdapter {lvalue})

Class symbolProvider

Get abstaract access to different type info sources

Base classes:

instance

Methods:

  • __iter__
  • iter

Method symbolProvider.__iter__


__iter__( (symbolProvider)arg1) -> symbolIterator :

    C++ signature :
        struct pykd::SymbolEnumeratorAdapter * __ptr64 __iter__(class boost::shared_ptr<class kdlib::SymbolProvider>)

Method symbolProvider.iter


iter( (symbolProvider)arg1, (str)arg2) -> symbolIterator :
    Return type iterator with specified mask

    C++ signature :
        struct pykd::SymbolEnumeratorAdapter * __ptr64 iter(class boost::shared_ptr<class kdlib::SymbolProvider>,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Class syntheticSymbol

Structure describes a synthetic symbol within a module

Base classes:

instance

Properties:

  • moduleBase
  • symbolId

Methods:

  • __str__

Property syntheticSymbol.moduleBase

The location in the target's virtual address space of the module's base address

Property syntheticSymbol.symbolId

The symbol ID of the symbol within the module

Method syntheticSymbol.__str__


__str__( (syntheticSymbol)arg1) -> str :
    Return object as a string

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(struct kdlib::SyntheticSymbol)

Class systemVersion

Operation system version

Base classes:

instance

Properties:

  • buildNumber
  • buildString
  • servicePack
  • win32Major
  • win32Minor

Methods:

  • __str__

Property systemVersion.buildNumber

Build number for the target's operating system

Property systemVersion.buildString

String that identifies the build of the system

Property systemVersion.servicePack

Service Pack Number

Property systemVersion.win32Major

Major version number of the target's operating system

Property systemVersion.win32Minor

Minor version number of the target's operating system

Method systemVersion.__str__


__str__( (systemVersion)arg1) -> str :
    Return object as a string

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(struct kdlib::SystemInfo {lvalue})

Class targetHeap

Class representing heap in the target process

Base classes:

instance

Methods:

  • entries

Method targetHeap.entries


entries( (targetHeap)arg1 [, (str)typeName [, (int)minSize [, (int)maxSize]]]) -> targetHeapIterator :
    Return heap's entries iterator object

    C++ signature :
        class pykd::TargetHeapIterator * __ptr64 entries(class kdlib::TargetHeap {lvalue} [,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,unsigned __int64 [,unsigned __int64]]])

Class targetHeapIterator

iterator for typedVar array

Base classes:

instance

Methods:

  • __iter__
  • __len__
  • __next__

Method targetHeapIterator.__iter__


__iter__( (object)arg1) -> object :

    C++ signature :
        class boost::python::api::object __iter__(class boost::python::api::object)

Method targetHeapIterator.__len__


__len__( (targetHeapIterator)arg1) -> int :

    C++ signature :
        unsigned __int64 __len__(class pykd::TargetHeapIterator {lvalue})

Method targetHeapIterator.__next__


__next__( (targetHeapIterator)arg1) -> tuple :

    C++ signature :
        class boost::python::tuple __next__(class pykd::TargetHeapIterator {lvalue})

Class targetProcess

Class representing process in the target system

Base classes:

instance

Properties:

  • exeName
  • id
  • peb
  • systemID

Methods:

  • __init__
  • __str__
  • breakpoints
  • currentThread
  • getBreakpoint
  • getManagedHeap
  • getManagedVar
  • getModule
  • getModuleByName
  • getModuleByOffset
  • getNumberBreakpoints
  • getNumberModules
  • getNumberThreads
  • getThread
  • getThreadById
  • getThreadBySystemId
  • isCurrent
  • isManaged
  • modules
  • setCurrent
  • threads

Property targetProcess.exeName

Return the process executable file name

Property targetProcess.id

Return process id

Property targetProcess.peb

Return PEB address

Property targetProcess.systemID

Retrun system process ID ( PID )

Method targetProcess.__init__


__init__( (object)arg1 [, (int)arg2]) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object [,unsigned long])

Method targetProcess.__str__


__str__( (targetProcess)arg1) -> str :

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(class kdlib::TargetProcess {lvalue})

Method targetProcess.breakpoints


breakpoints( (targetProcess)arg1) -> list :
    Return list of breakpoints for the target process

    C++ signature :
        class boost::python::list breakpoints(class kdlib::TargetProcess {lvalue})

Method targetProcess.currentThread


currentThread( (targetProcess)arg1) -> targetThread :
    Return current thread

    C++ signature :
        class boost::shared_ptr<class kdlib::TargetThread> currentThread(class kdlib::TargetProcess {lvalue})

Method targetProcess.getBreakpoint


getBreakpoint( (targetProcess)arg1, (int)arg2) -> breakpoint :
    Return a breakpoint by it's index

    C++ signature :
        class pykd::Breakpoint * __ptr64 getBreakpoint(class kdlib::TargetProcess {lvalue},unsigned long)

Method targetProcess.getManagedHeap


getManagedHeap( (targetProcess)arg1) -> targetHeap :
    Return object representing a managed heap

    C++ signature :
        class boost::shared_ptr<class kdlib::TargetHeap> getManagedHeap(class kdlib::TargetProcess {lvalue})

Method targetProcess.getManagedVar


getManagedVar( (targetProcess)arg1, (int)arg2) -> typedVar :
    Return object representing a managed object in the target managed process

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> getManagedVar(class kdlib::TargetProcess {lvalue},unsigned __int64)

Method targetProcess.getModule


getModule( (targetProcess)arg1, (int)arg2) -> module :
    Return a module object by it's index

    C++ signature :
        class boost::shared_ptr<class kdlib::Module> getModule(class kdlib::TargetProcess {lvalue},unsigned long)

Method targetProcess.getModuleByName


getModuleByName( (targetProcess)arg1, (str)arg2) -> module :
    Return a module object by it's name

    C++ signature :
        class boost::shared_ptr<class kdlib::Module> getModuleByName(class kdlib::TargetProcess {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method targetProcess.getModuleByOffset


getModuleByOffset( (targetProcess)arg1, (int)arg2) -> module :
    Return a module object by it's offset

    C++ signature :
        class boost::shared_ptr<class kdlib::Module> getModuleByOffset(class kdlib::TargetProcess {lvalue},unsigned __int64)

Method targetProcess.getNumberBreakpoints


getNumberBreakpoints( (targetProcess)arg1) -> int :
    Return number of breakpoints for this process

    C++ signature :
        unsigned long getNumberBreakpoints(class kdlib::TargetProcess {lvalue})

Method targetProcess.getNumberModules


getNumberModules( (targetProcess)arg1) -> int :
    Return number of modules for this process

    C++ signature :
        unsigned long getNumberModules(class kdlib::TargetProcess {lvalue})

Method targetProcess.getNumberThreads


getNumberThreads( (targetProcess)arg1) -> int :
    Return number of threads for this process

    C++ signature :
        unsigned long getNumberThreads(class kdlib::TargetProcess {lvalue})

Method targetProcess.getThread


getThread( (targetProcess)arg1, (int)arg2) -> targetThread :
    Return thread by its index

    C++ signature :
        class boost::shared_ptr<class kdlib::TargetThread> getThread(class kdlib::TargetProcess {lvalue},unsigned long)

Method targetProcess.getThreadById


getThreadById( (targetProcess)arg1, (int)arg2) -> targetThread :
    Return thread by its index

    C++ signature :
        class boost::shared_ptr<class kdlib::TargetThread> getThreadById(class kdlib::TargetProcess {lvalue},unsigned long)

Method targetProcess.getThreadBySystemId


getThreadBySystemId( (targetProcess)arg1, (int)arg2) -> targetThread :
    Return thread by tid

    C++ signature :
        class boost::shared_ptr<class kdlib::TargetThread> getThreadBySystemId(class kdlib::TargetProcess {lvalue},unsigned long)

Method targetProcess.isCurrent


isCurrent( (targetProcess)arg1) -> bool :
    Check if the target is current

    C++ signature :
        bool isCurrent(class kdlib::TargetProcess {lvalue})

Method targetProcess.isManaged


isManaged( (targetProcess)arg1) -> bool :
    Check if the taget process is managed

    C++ signature :
        bool isManaged(class kdlib::TargetProcess {lvalue})

Method targetProcess.modules


modules( (targetProcess)arg1) -> list :
    Return list of modules for the target process

    C++ signature :
        class boost::python::list modules(class kdlib::TargetProcess {lvalue})

Method targetProcess.setCurrent


setCurrent( (targetProcess)arg1) -> None :
    Set this process as a current

    C++ signature :
        void setCurrent(class kdlib::TargetProcess {lvalue})

Method targetProcess.threads


threads( (targetProcess)arg1) -> list :
    Return list of threads for the target process

    C++ signature :
        class boost::python::list threads(class kdlib::TargetProcess {lvalue})

Class targetSystem

Class representing target system

Base classes:

instance

Properties:

  • desc
  • id

Methods:

  • __init__
  • __str__
  • currentProcess
  • getNumberProcesses
  • getProcess
  • getProcessById
  • getProcessBySystemId
  • is64bitSystem
  • isCurrent
  • isDumpAnalyzing
  • isKernelDebugging
  • processes
  • setCurrent

Property targetSystem.desc

Retunr target system description

Property targetSystem.id

Return id of the target system

Method targetSystem.__init__


__init__( (object)arg1) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object)

__init__( (object)arg1, (int)arg2) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object,unsigned long)

Method targetSystem.__str__


__str__( (targetSystem)arg1) -> str :

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(class kdlib::TargetSystem {lvalue})

Method targetSystem.currentProcess


currentProcess( (targetSystem)arg1) -> targetProcess :
    Return current process

    C++ signature :
        class boost::shared_ptr<class kdlib::TargetProcess> currentProcess(class kdlib::TargetSystem {lvalue})

Method targetSystem.getNumberProcesses


getNumberProcesses( (targetSystem)arg1) -> int :
    Return processed number of the target system

    C++ signature :
        unsigned long getNumberProcesses(class kdlib::TargetSystem {lvalue})

Method targetSystem.getProcess


getProcess( (targetSystem)arg1, (int)arg2) -> targetProcess :
    Return process by index

    C++ signature :
        class boost::shared_ptr<class kdlib::TargetProcess> getProcess(class kdlib::TargetSystem {lvalue},unsigned long)

Method targetSystem.getProcessById


getProcessById( (targetSystem)arg1, (int)arg2) -> targetProcess :
    Return process by id

    C++ signature :
        class boost::shared_ptr<class kdlib::TargetProcess> getProcessById(class kdlib::TargetSystem {lvalue},unsigned long)

Method targetSystem.getProcessBySystemId


getProcessBySystemId( (targetSystem)arg1, (int)arg2) -> targetProcess :
    Return process by PID

    C++ signature :
        class boost::shared_ptr<class kdlib::TargetProcess> getProcessBySystemId(class kdlib::TargetSystem {lvalue},unsigned long)

Method targetSystem.is64bitSystem


is64bitSystem( (targetSystem)arg1) -> bool :
    Check if 64 bit system running

    C++ signature :
        bool is64bitSystem(class kdlib::TargetSystem {lvalue})

Method targetSystem.isCurrent


isCurrent( (targetSystem)arg1) -> bool :
    Check if the target is current

    C++ signature :
        bool isCurrent(class kdlib::TargetSystem {lvalue})

Method targetSystem.isDumpAnalyzing


isDumpAnalyzing( (targetSystem)arg1) -> bool :
    Check if it is a dump analyzing ( not living debuggee )

    C++ signature :
        bool isDumpAnalyzing(class kdlib::TargetSystem {lvalue})

Method targetSystem.isKernelDebugging


isKernelDebugging( (targetSystem)arg1) -> bool :
    Check if kernel dubugging is running

    C++ signature :
        bool isKernelDebugging(class kdlib::TargetSystem {lvalue})

Method targetSystem.processes


processes( (targetSystem)arg1) -> list :
    get list of processes for the target system

    C++ signature :
        class boost::python::list processes(class kdlib::TargetSystem {lvalue})

Method targetSystem.setCurrent


setCurrent( (targetSystem)arg1) -> None :
    set system as a current

    C++ signature :
        void setCurrent(class kdlib::TargetSystem {lvalue})

Class targetThread

Class representing thread in the target process

Base classes:

instance

Properties:

  • fp
  • frameOffset
  • id
  • instructionOffset
  • ip
  • sp
  • stackOffset
  • systemID
  • teb

Methods:

  • __init__
  • __str__
  • isCurrent
  • setCurrent
  • stack

Property targetThread.fp

frame pointer

Property targetThread.frameOffset

Return a frame's offset

Property targetThread.id

Return thread's id

Property targetThread.instructionOffset

Return an instruction offset

Property targetThread.ip

instruction pointer

Property targetThread.sp

stack pointer

Property targetThread.stackOffset

Return a stack pointer

Property targetThread.systemID

Retrun system thread ID ( TID )

Property targetThread.teb

Return TEB address

Method targetThread.__init__


__init__( (object)arg1 [, (int)arg2]) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object [,unsigned long])

Method targetThread.__str__


__str__( (targetThread)arg1) -> str :

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(class kdlib::TargetThread {lvalue})

Method targetThread.isCurrent


isCurrent( (targetThread)arg1) -> bool :
    Check if this thread is current

    C++ signature :
        bool isCurrent(class kdlib::TargetThread {lvalue})

Method targetThread.setCurrent


setCurrent( (targetThread)arg1) -> None :
    Set this thread current

    C++ signature :
        void setCurrent(class kdlib::TargetThread {lvalue})

Method targetThread.stack


stack( (targetThread)arg1) -> list :
    Get thread's stack tarce

    C++ signature :
        class boost::python::list stack(class kdlib::TargetThread {lvalue})

Class typeInfo

Class representing typeInfo

Base classes:

numVariant

Methods:

  • __bool__
  • __contains__
  • __dir__
  • __getattr__
  • __getitem__
  • __init__
  • __len__
  • __str__
  • append
  • arrayOf
  • baseClass
  • baseClassOffset
  • baseClasses
  • bitOffset
  • bitWidth
  • deref
  • field
  • fieldName
  • fieldOffset
  • fields
  • getCallingConvention
  • getClassParent
  • getNumberBaseClasses
  • getNumberFields
  • getNumberMethods
  • getTemplateArgs
  • getTypedVar
  • hasField
  • hasMethod
  • isArray
  • isBase
  • isBitField
  • isConstField
  • isConstant
  • isEnum
  • isFunction
  • isNoType
  • isPointer
  • isStaticField
  • isTemplate
  • isUserDefined
  • isVoid
  • isVtbl
  • members
  • method
  • methodName
  • name
  • ptrTo
  • scopeName
  • size
  • staticOffset

Method typeInfo.__bool__


__bool__( (typeInfo)arg1) -> bool :

    C++ signature :
        bool __bool__(class kdlib::TypeInfo {lvalue})

Method typeInfo.__contains__


__contains__( (typeInfo)arg1, (str)arg2) -> bool :

    C++ signature :
        bool __contains__(class boost::shared_ptr<class kdlib::TypeInfo> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typeInfo.__dir__


__dir__( (typeInfo)arg1) -> list :

    C++ signature :
        class boost::python::list __dir__(class kdlib::TypeInfo {lvalue})

Method typeInfo.__getattr__


__getattr__( (typeInfo)arg1, (str)arg2) -> typeInfo :

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> __getattr__(class kdlib::TypeInfo {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typeInfo.__getitem__


__getitem__( (typeInfo)arg1, (int)arg2) -> typeInfo :

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> __getitem__(class kdlib::TypeInfo {lvalue},unsigned __int64)

__getitem__( (typeInfo)arg1, (str)arg2) -> typeInfo :

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> __getitem__(class kdlib::TypeInfo {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typeInfo.__init__


__init__( (object)arg1, (str)arg2) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typeInfo.__len__


__len__( (typeInfo)arg1) -> int :

    C++ signature :
        unsigned __int64 __len__(class kdlib::TypeInfo {lvalue})

Method typeInfo.__str__


__str__( (typeInfo)arg1) -> str :
    Return type as a printable string

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(class kdlib::TypeInfo {lvalue})

Method typeInfo.append


append( (typeInfo)arg1, (str)arg2, (typeInfo)arg3) -> None :
    Add a new field to custom defined struct

    C++ signature :
        void append(class kdlib::TypeInfo {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class boost::shared_ptr<class kdlib::TypeInfo> {lvalue})

Method typeInfo.arrayOf


arrayOf( (typeInfo)arg1, (int)arg2) -> typeInfo :
    Return array of the type

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> arrayOf(class kdlib::TypeInfo {lvalue},unsigned __int64)

Method typeInfo.baseClass


baseClass( (typeInfo)arg1, (str)arg2) -> typeInfo :
    Return a base class's type by name

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> baseClass(class kdlib::TypeInfo {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

baseClass( (typeInfo)arg1, (int)arg2) -> typeInfo :
    Return a base class's type by index

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> baseClass(class kdlib::TypeInfo {lvalue},unsigned __int64)

Method typeInfo.baseClassOffset


baseClassOffset( (typeInfo)arg1, (str)arg2) -> int :
    Return a base class offset by name

    C++ signature :
        unsigned long baseClassOffset(class kdlib::TypeInfo {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

baseClassOffset( (typeInfo)arg1, (int)arg2) -> int :
    Return a base class offset by index

    C++ signature :
        unsigned long baseClassOffset(class kdlib::TypeInfo {lvalue},unsigned __int64)

Method typeInfo.baseClasses


baseClasses( (typeInfo)arg1) -> list :
    Return list of tuples ( baseClassName, baseClassOffset, baseClassType)

    C++ signature :
        class boost::python::list baseClasses(class kdlib::TypeInfo {lvalue})

Method typeInfo.bitOffset


bitOffset( (typeInfo)arg1) -> int :
    Return bit field's offset

    C++ signature :
        unsigned long bitOffset(class kdlib::TypeInfo {lvalue})

Method typeInfo.bitWidth


bitWidth( (typeInfo)arg1) -> int :
    Return bit field's length

    C++ signature :
        unsigned long bitWidth(class kdlib::TypeInfo {lvalue})

Method typeInfo.deref


deref( (typeInfo)arg1) -> typeInfo :
    Return type of pointer

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> deref(class kdlib::TypeInfo {lvalue})

Method typeInfo.field


field( (typeInfo)arg1, (int)arg2) -> typeInfo :
    Return field's type by index

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> field(class kdlib::TypeInfo {lvalue},unsigned __int64)

field( (typeInfo)arg1, (str)arg2) -> typeInfo :
    Return field's type

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> field(class kdlib::TypeInfo {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typeInfo.fieldName


fieldName( (typeInfo)arg1, (int)arg2) -> str :
    Return name of struct field by index

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > fieldName(class kdlib::TypeInfo {lvalue},unsigned __int64)

Method typeInfo.fieldOffset


fieldOffset( (typeInfo)arg1, (str)arg2) -> int :
    Return offset of the nonstatic field

    C++ signature :
        unsigned long fieldOffset(class kdlib::TypeInfo {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

fieldOffset( (typeInfo)arg1, (int)arg2) -> int :
    Return offset of the nonstatic field by index

    C++ signature :
        unsigned long fieldOffset(class kdlib::TypeInfo {lvalue},unsigned __int64)

Method typeInfo.fields


fields( (typeInfo)arg1) -> list :
    Return list of tuple ( filedName, fieldType )

    C++ signature :
        class boost::python::list fields(class boost::shared_ptr<class kdlib::TypeInfo>)

Method typeInfo.getCallingConvention


getCallingConvention( (typeInfo)arg1) -> callingConvention :
    Returns an indicator of a methods calling convention: callingConvention

    C++ signature :
        enum kdlib::CallingConventionType getCallingConvention(class kdlib::TypeInfo {lvalue})

Method typeInfo.getClassParent


getClassParent( (typeInfo)arg1) -> typeInfo :
    Return class parent

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> getClassParent(class kdlib::TypeInfo {lvalue})

Method typeInfo.getNumberBaseClasses


getNumberBaseClasses( (typeInfo)arg1) -> int :
    Return number of base classes

    C++ signature :
        unsigned __int64 getNumberBaseClasses(class kdlib::TypeInfo {lvalue})

Method typeInfo.getNumberFields


getNumberFields( (typeInfo)arg1) -> int :
    Return number of fields

    C++ signature :
        unsigned __int64 getNumberFields(class kdlib::TypeInfo {lvalue})

Method typeInfo.getNumberMethods


getNumberMethods( (typeInfo)arg1) -> int :
    Return number of methods

    C++ signature :
        unsigned __int64 getNumberMethods(class kdlib::TypeInfo {lvalue})

Method typeInfo.getTemplateArgs


getTemplateArgs( (typeInfo)arg1) -> list :
    Return list if template arguments

    C++ signature :
        class boost::python::list getTemplateArgs(class boost::shared_ptr<class kdlib::TypeInfo>)

Method typeInfo.getTypedVar


getTypedVar( (typeInfo)arg1, (object)arg2) -> typedVar :
    return typedVar instance

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> getTypedVar(class boost::shared_ptr<class kdlib::TypeInfo>,class boost::python::api::object {lvalue})

Method typeInfo.hasField


hasField( (typeInfo)arg1, (str)arg2) -> bool :
    Return True if type has a field with the specified name

    C++ signature :
        bool hasField(class boost::shared_ptr<class kdlib::TypeInfo> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typeInfo.hasMethod


hasMethod( (typeInfo)arg1, (str)arg2) -> bool :
    Return True if type has a method with the specified name

    C++ signature :
        bool hasMethod(class boost::shared_ptr<class kdlib::TypeInfo> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typeInfo.isArray


isArray( (typeInfo)arg1) -> bool :
    Return flag: type is array

    C++ signature :
        bool isArray(class kdlib::TypeInfo {lvalue})

Method typeInfo.isBase


isBase( (typeInfo)arg1) -> bool :
    Return flag: type is base

    C++ signature :
        bool isBase(class kdlib::TypeInfo {lvalue})

Method typeInfo.isBitField


isBitField( (typeInfo)arg1) -> bool :
    Return flag: type is bit field

    C++ signature :
        bool isBitField(class kdlib::TypeInfo {lvalue})

Method typeInfo.isConstField


isConstField( (typeInfo)arg1, (str)arg2) -> bool :
    Return True if a field is a const field by field name

    C++ signature :
        bool isConstField(class boost::shared_ptr<class kdlib::TypeInfo>,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

isConstField( (typeInfo)arg1, (int)arg2) -> bool :
    Return True if a field is a const field by field name

    C++ signature :
        bool isConstField(class boost::shared_ptr<class kdlib::TypeInfo>,unsigned __int64)

Method typeInfo.isConstant


isConstant( (typeInfo)arg1) -> bool :
    Return flag: type is constant

    C++ signature :
        bool isConstant(class kdlib::TypeInfo {lvalue})

Method typeInfo.isEnum


isEnum( (typeInfo)arg1) -> bool :
    Return flag: type is enum

    C++ signature :
        bool isEnum(class kdlib::TypeInfo {lvalue})

Method typeInfo.isFunction


isFunction( (typeInfo)arg1) -> bool :
    Return flag: type is function

    C++ signature :
        bool isFunction(class kdlib::TypeInfo {lvalue})

Method typeInfo.isNoType


isNoType( (typeInfo)arg1) -> bool :
    Return true if type is virtual table

    C++ signature :
        bool isNoType(class kdlib::TypeInfo {lvalue})

Method typeInfo.isPointer


isPointer( (typeInfo)arg1) -> bool :
    Return flag: type is pointer

    C++ signature :
        bool isPointer(class kdlib::TypeInfo {lvalue})

Method typeInfo.isStaticField


isStaticField( (typeInfo)arg1, (str)arg2) -> bool :
    Return True if a field is a static field by field name

    C++ signature :
        bool isStaticField(class boost::shared_ptr<class kdlib::TypeInfo>,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

isStaticField( (typeInfo)arg1, (int)arg2) -> bool :
    Return True if a field is a static field by field name

    C++ signature :
        bool isStaticField(class boost::shared_ptr<class kdlib::TypeInfo>,unsigned __int64)

Method typeInfo.isTemplate


isTemplate( (typeInfo)arg1) -> bool :
    Return true if type is template

    C++ signature :
        bool isTemplate(class boost::shared_ptr<class kdlib::TypeInfo>)

Method typeInfo.isUserDefined


isUserDefined( (typeInfo)arg1) -> bool :
    Return flag: type is UDT

    C++ signature :
        bool isUserDefined(class kdlib::TypeInfo {lvalue})

Method typeInfo.isVoid


isVoid( (typeInfo)arg1) -> bool :
    Return flag: type is void

    C++ signature :
        bool isVoid(class kdlib::TypeInfo {lvalue})

Method typeInfo.isVtbl


isVtbl( (typeInfo)arg1) -> bool :
    Return true if no type is specified

    C++ signature :
        bool isVtbl(class kdlib::TypeInfo {lvalue})

Method typeInfo.members


members( (typeInfo)arg1) -> list :
    Return list of tuple ( memberName, fieldType ). Only defined member, not inherited from base class

    C++ signature :
        class boost::python::list members(class boost::shared_ptr<class kdlib::TypeInfo>)

Method typeInfo.method


method( (typeInfo)arg1, (str)arg2) -> typeInfo :
    Return method's type by name

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> method(class kdlib::TypeInfo {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

method( (typeInfo)arg1, (int)arg2) -> typeInfo :
    Return method's by index

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> method(class kdlib::TypeInfo {lvalue},unsigned __int64)

Method typeInfo.methodName


methodName( (typeInfo)arg1, (int)arg2) -> str :
    Return method's name

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > methodName(class kdlib::TypeInfo {lvalue},unsigned __int64)

Method typeInfo.name


name( (typeInfo)arg1) -> str :
    Return type name

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > name(class kdlib::TypeInfo {lvalue})

Method typeInfo.ptrTo


ptrTo( (typeInfo)arg1 [, (int)ptrSize]) -> typeInfo :
    Return pointer to the type

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> ptrTo(class kdlib::TypeInfo {lvalue} [,unsigned __int64])

Method typeInfo.scopeName


scopeName( (typeInfo)arg1) -> str :
    Return name of type scope ( module name )

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > scopeName(class kdlib::TypeInfo {lvalue})

Method typeInfo.size


size( (typeInfo)arg1) -> int :
    Return type size

    C++ signature :
        unsigned __int64 size(class kdlib::TypeInfo {lvalue})

Method typeInfo.staticOffset


staticOffset( (typeInfo)arg1, (str)arg2) -> int :
    Return offset of the static field

    C++ signature :
        unsigned __int64 staticOffset(class kdlib::TypeInfo {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Class typeInfoProvider

Get abstaract access to different type info sources

Base classes:

instance

Methods:

  • __getattr__
  • __iter__
  • getTypeByName
  • typeIterator

Method typeInfoProvider.__getattr__


__getattr__( (typeInfoProvider)arg1, (str)arg2) -> typeInfo :

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> __getattr__(class kdlib::TypeInfoProvider {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typeInfoProvider.__iter__


__iter__( (typeInfoProvider)arg1) -> typeInfoProviderIterator :

    C++ signature :
        class pykd::TypeInfoProviderIterator * __ptr64 __iter__(class kdlib::TypeInfoProvider {lvalue})

Method typeInfoProvider.getTypeByName


getTypeByName( (typeInfoProvider)arg1, (str)arg2) -> typeInfo :
    Get type info by it's name

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> getTypeByName(class kdlib::TypeInfoProvider {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typeInfoProvider.typeIterator


typeIterator( (typeInfoProvider)arg1, (str)arg2) -> typeInfoProviderIterator :
    Return type iterator with specified mask

    C++ signature :
        class pykd::TypeInfoProviderIterator * __ptr64 typeIterator(class kdlib::TypeInfoProvider {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Class typeInfoProviderIterator

iterator for type provider

Base classes:

instance

Methods:

  • __iter__
  • __next__

Method typeInfoProviderIterator.__iter__


__iter__( (object)arg1) -> object :

    C++ signature :
        class boost::python::api::object __iter__(class boost::python::api::object)

Method typeInfoProviderIterator.__next__


__next__( (typeInfoProviderIterator)arg1) -> typeInfo :

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> __next__(class pykd::TypeInfoProviderIterator {lvalue})

Class typedVar

Class of non-primitive type object, child class of typeClass. Data from target is copied into object instance

Base classes:

numVariant

Methods:

  • __bool__
  • __call__
  • __contains__
  • __dir__
  • __getattr__
  • __getitem__
  • __init__
  • __iter__
  • __len__
  • __setattr__
  • __setitem__
  • __str__
  • call
  • castTo
  • deref
  • field
  • fieldName
  • fieldOffset
  • fields
  • getAddress
  • getDebugEnd
  • getDebugStart
  • getLocation
  • getNumberFields
  • hasField
  • hasMethod
  • members
  • method
  • rawBytes
  • setField
  • sizeof
  • type

Method typedVar.__bool__


__bool__( (typedVar)arg1) -> bool :

    C++ signature :
        bool __bool__(class kdlib::TypedVar {lvalue})

Method typedVar.__call__


object __call__(tuple args, dict kwds) :

    C++ signature :
        object __call__(tuple args, dict kwds)

Method typedVar.__contains__


__contains__( (typedVar)arg1, (str)arg2) -> bool :

    C++ signature :
        bool __contains__(class boost::shared_ptr<class kdlib::TypedVar> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typedVar.__dir__


__dir__( (typedVar)arg1) -> list :

    C++ signature :
        class boost::python::list __dir__(class kdlib::TypedVar {lvalue})

Method typedVar.__getattr__


__getattr__( (typedVar)arg1, (str)arg2) -> typedVar :
    Return field of structure as an object attribute

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> __getattr__(class kdlib::TypedVar {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typedVar.__getitem__


__getitem__( (typedVar)arg1, (int)arg2) -> typedVar :

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> __getitem__(class kdlib::TypedVar {lvalue},long)

__getitem__( (typedVar)arg1, (str)arg2) -> typedVar :

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> __getitem__(class kdlib::TypedVar {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typedVar.__init__


__init__( (object)arg1, (str)arg2) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

__init__( (object)arg1, (str)arg2, (object)arg3) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class boost::python::api::object {lvalue})

__init__( (object)arg1, (typeInfo)arg2, (object)arg3) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object,class boost::shared_ptr<class kdlib::TypeInfo>,class boost::python::api::object {lvalue})

__init__( (object)arg1, (str)arg2, (str)arg3) -> object :

    C++ signature :
        void * __ptr64 __init__(class boost::python::api::object,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typedVar.__iter__


__iter__( (typedVar)arg1) -> typedVarIterator :

    C++ signature :
        class pykd::TypedVarIterator * __ptr64 __iter__(class boost::shared_ptr<class kdlib::TypedVar> {lvalue})

Method typedVar.__len__


__len__( (typedVar)arg1) -> int :

    C++ signature :
        unsigned __int64 __len__(class kdlib::TypedVar {lvalue})

Method typedVar.__setattr__


__setattr__( (typedVar)arg1, (str)arg2, (object)arg3) -> None :

    C++ signature :
        void __setattr__(class kdlib::TypedVar {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class boost::python::api::object {lvalue})

Method typedVar.__setitem__


__setitem__( (typedVar)arg1, (int)arg2, (object)arg3) -> None :

    C++ signature :
        void __setitem__(class kdlib::TypedVar {lvalue},long,class boost::python::api::object {lvalue})

__setitem__( (typedVar)arg1, (str)arg2, (object)arg3) -> None :

    C++ signature :
        void __setitem__(class kdlib::TypedVar {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class boost::python::api::object {lvalue})

Method typedVar.__str__


__str__( (typedVar)arg1) -> str :

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > __str__(class kdlib::TypedVar {lvalue})

Method typedVar.call


object call(tuple args, dict kwds) :

    C++ signature :
        object call(tuple args, dict kwds)

Method typedVar.castTo


castTo( (typedVar)arg1, (str)arg2) -> typedVar :
    Cast variable to the type and return new typedVar instance

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> castTo(class kdlib::TypedVar {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

castTo( (typedVar)arg1, (typeInfo)arg2) -> typedVar :
    Cast variable to the type and return new typedVar instance

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> castTo(class kdlib::TypedVar {lvalue},class boost::shared_ptr<class kdlib::TypeInfo>)

Method typedVar.deref


deref( (typedVar)arg1) -> typedVar :
    Return value by pointer

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> deref(class kdlib::TypedVar {lvalue})

Method typedVar.field


field( (typedVar)arg1, (str)arg2) -> typedVar :
    Return field of structure

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> field(class kdlib::TypedVar {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

field( (typedVar)arg1, (int)arg2) -> typedVar :
    Return field of structure or array

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> field(class kdlib::TypedVar {lvalue},long)

Method typedVar.fieldName


fieldName( (typedVar)arg1, (int)arg2) -> str :
    Return name of struct field by index

    C++ signature :
        class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > fieldName(class kdlib::TypedVar {lvalue},long)

Method typedVar.fieldOffset


fieldOffset( (typedVar)arg1, (str)arg2) -> int :
    Return target field offset

    C++ signature :
        unsigned long fieldOffset(class kdlib::TypedVar {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typedVar.fields


fields( (typedVar)arg1) -> list :
    Return list of tuple ( filedName, fieldOffset, fieldValue )

    C++ signature :
        class boost::python::list fields(class boost::shared_ptr<class kdlib::TypedVar>)

Method typedVar.getAddress


getAddress( (typedVar)arg1) -> int :
    Return virtual address

    C++ signature :
        unsigned __int64 getAddress(class kdlib::TypedVar {lvalue})

Method typedVar.getDebugEnd


getDebugEnd( (typedVar)arg1) -> int :
    Return beginning location of the function's epilogue code (virtual address)

    C++ signature :
        unsigned __int64 getDebugEnd(class kdlib::TypedVar {lvalue})

Method typedVar.getDebugStart


getDebugStart( (typedVar)arg1) -> int :
    Return end location of the function's prologue code (virtual address)

    C++ signature :
        unsigned __int64 getDebugStart(class kdlib::TypedVar {lvalue})

Method typedVar.getLocation


getLocation( (typedVar)arg1) -> tuple :
    Return location of the varibale

    C++ signature :
        class boost::python::tuple getLocation(class kdlib::TypedVar {lvalue})

Method typedVar.getNumberFields


getNumberFields( (typedVar)arg1) -> int :
    Return number of fields

    C++ signature :
        unsigned __int64 getNumberFields(class kdlib::TypedVar {lvalue})

Method typedVar.hasField


hasField( (typedVar)arg1, (str)arg2) -> bool :
    Check if a typedVar object has the specified field

    C++ signature :
        bool hasField(class boost::shared_ptr<class kdlib::TypedVar> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typedVar.hasMethod


hasMethod( (typedVar)arg1, (str)arg2) -> bool :
    Check if a typedVar object has the specified method

    C++ signature :
        bool hasMethod(class boost::shared_ptr<class kdlib::TypedVar> {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >)

Method typedVar.members


members( (typedVar)arg1) -> list :
    Return list of tuple ( filedName, fieldOffset, fieldValue )

    C++ signature :
        class boost::python::list members(class boost::shared_ptr<class kdlib::TypedVar>)

Method typedVar.method


method( (typedVar)arg1, (str)name [, (str)prototype='']) -> typedVar :
    Return method of class as an object attribute

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> method(class kdlib::TypedVar {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> > [,class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >=''])

Method typedVar.rawBytes


rawBytes( (typedVar)arg1) -> list :
    Return list of bytes

    C++ signature :
        class boost::python::list rawBytes(class kdlib::TypedVar {lvalue})

Method typedVar.setField


setField( (typedVar)arg1, (str)arg2, (object)arg3) -> None :
    Set field of structure

    C++ signature :
        void setField(class kdlib::TypedVar {lvalue},class std::basic_string<wchar_t,struct std::char_traits<wchar_t>,class std::allocator<wchar_t> >,class boost::python::api::object {lvalue})

setField( (typedVar)arg1, (int)arg2, (object)arg3) -> None :
    Set field of a structire or an element od array

    C++ signature :
        void setField(class kdlib::TypedVar {lvalue},long,class boost::python::api::object {lvalue})

Method typedVar.sizeof


sizeof( (typedVar)arg1) -> int :
    Return size of a variable in the target memory

    C++ signature :
        unsigned __int64 sizeof(class kdlib::TypedVar {lvalue})

Method typedVar.type


type( (typedVar)arg1) -> typeInfo :
    Return typeInfo instance

    C++ signature :
        class boost::shared_ptr<class kdlib::TypeInfo> type(class kdlib::TypedVar {lvalue})

Class typedVarIterator

iterator for typedVar array

Base classes:

instance

Methods:

  • __iter__
  • __next__

Method typedVarIterator.__iter__


__iter__( (object)arg1) -> object :

    C++ signature :
        class boost::python::api::object __iter__(class boost::python::api::object)

Method typedVarIterator.__next__


__next__( (typedVarIterator)arg1) -> typedVar :

    C++ signature :
        class boost::shared_ptr<class kdlib::TypedVar> __next__(class pykd::TypedVarIterator {lvalue})
Clone repository
  • 0.3.3.1
  • 0.3.3.2
  • 0.3.3.3
  • 0.3.3.4
  • 0.3.4.0
  • 0.3.4.1
  • 0.3.4.10
  • 0.3.4.11
  • 0.3.4.12
  • 0.3.4.13
  • 0.3.4.14
  • 0.3.4.15
  • 0.3.4.2
  • 0.3.4.3
  • 0.3.4.4
View All Pages