Edit

Api.JetGetSystemParameter method (JET_INSTANCE, JET_SESID, JET_param, IntPtr, String, Int32)

  • Article

Gets database configuration options.

Namespace:  Microsoft.Isam.Esent.Interop
Assembly:  Microsoft.Isam.Esent.Interop (in Microsoft.Isam.Esent.Interop.dll)

Syntax

'Declaration
Public Shared Function JetGetSystemParameter ( _
    instance As JET_INSTANCE, _
    sesid As JET_SESID, _
    paramid As JET_param, _
    ByRef paramValue As IntPtr, _
    <OutAttribute> ByRef paramString As String, _
    maxParam As Integer _
) As JET_wrn
'Usage
Dim instance As JET_INSTANCE
Dim sesid As JET_SESID
Dim paramid As JET_param
Dim paramValue As IntPtr
Dim paramString As String
Dim maxParam As Integer
Dim returnValue As JET_wrn

returnValue = Api.JetGetSystemParameter(instance, _
    sesid, paramid, paramValue, paramString, _
    maxParam)

public static JET_wrn JetGetSystemParameter(
    JET_INSTANCE instance,
    JET_SESID sesid,
    JET_param paramid,
    ref IntPtr paramValue,
    out string paramString,
    int maxParam
)

Parameters

  • paramValue
    Type: System.IntPtr

    Returns the value of the parameter, if the value is an integer.

  • paramString
    Type: System.String

    Returns the value of the parameter, if the value is a string.

  • maxParam
    Type: System.Int32

    The maximum size of the parameter string.

Return value

Type: Microsoft.Isam.Esent.Interop.JET_wrn
An ESENT warning code.

Remarks

ErrorToString passes in the error number in the paramValue, which is why it is a ref parameter and not an out parameter.

See also

Reference

Api class

Api members

JetGetSystemParameter overload

Microsoft.Isam.Esent.Interop namespace