Package com.sun.jna.platform.win32
Class WinRas.RASENTRY
java.lang.Object
com.sun.jna.Structure
com.sun.jna.platform.win32.WinRas.RASENTRY
- Direct Known Subclasses:
- WinRas.RASENTRY.ByReference
- Enclosing interface:
- WinRas
@FieldOrder({"dwSize","dwfOptions","dwCountryID","dwCountryCode","szAreaCode","szLocalPhoneNumber","dwAlternateOffset","ipaddr","ipaddrDns","ipaddrDnsAlt","ipaddrWins","ipaddrWinsAlt","dwFrameSize","dwfNetProtocols","dwFramingProtocol","szScript","szAutodialDll","szAutodialFunc","szDeviceType","szDeviceName","szX25PadType","szX25Address","szX25Facilities","szX25UserData","dwChannels","dwReserved1","dwReserved2","dwSubEntries","dwDialMode","dwDialExtraPercent","dwDialExtraSampleSeconds","dwHangUpExtraPercent","dwHangUpExtraSampleSeconds","dwIdleDisconnectSeconds","dwType","dwEncryptionType","dwCustomAuthKey","guidId","szCustomDialDll","dwVpnStrategy","dwfOptions2","dwfOptions3","szDnsSuffix","dwTcpWindowSize","szPrerequisitePbk","szPrerequisiteEntry","dwRedialCount","dwRedialPause","ipv6addrDns","ipv6addrDnsAlt","dwIPv4InterfaceMetric","dwIPv6InterfaceMetric","ipv6addr","dwIPv6PrefixLength","dwNetworkOutageTime"})
public static class WinRas.RASENTRY
extends Structure
The RASENTRY structure describes a phone-book entry. The RasSetEntryProperties and RasGetEntryProperties
 functions use this structure to set and retrieve the properties of a phone-book entry.
- 
Nested Class SummaryNested ClassesNested classes/interfaces inherited from class com.sun.jna.StructureStructure.ByValue, Structure.FieldOrder, Structure.StructField
- 
Field SummaryFieldsModifier and TypeFieldDescriptionintSpecifies the offset, in bytes, from the beginning of the structure to a list of consecutive null-terminated strings.intReserved for future useintSpecifies the country/region code portion of the phone number.intSpecifies the TAPI country/region identifier.intThis member is used for Extensible Authentication Protocol (EAP).intSpecifies a percent of the total bandwidth available from the currently connected subentries.intSpecifies the number of seconds that current bandwidth usage must exceed the threshold specified by dwDialExtraPercent before RAS dials an additional subentry.intSpecifies whether RAS should dial all of this entry's multilink subentries when the entry is first connected.intThe type of encryption to use with the connection.intSpecifies the network protocols to negotiate.intA set of bit flags that specify connection options.intA set of bits that specify connection options.intThis parameter is reserved for future use.intSpecifies the IP address of a secondary WINS server to be used while this connection is active.intSpecifies the framing protocol used by the server.intSpecifies a percent of the total bandwidth available from the currently connected subentries.intSpecifies the number of seconds that current bandwidth usage must be less than the threshold specified by dwHangUpExtraPercent before RAS terminates an existing subentry connection.intSpecifies the number of seconds after which the connection is terminated due to inactivity.intSets the metric of the IPv4 stack for this interface.intSets the metric of the IPv6 stack for this interface.intThe length of the IPv6 address prefix in ipv6addr.intSpecifies the amount of time, in minutes, that IKEv2 packets will be retransmitted without a response before the connection is considered lost.intSpecifies the number of times RAS attempts to redial a connection.intSpecifies the number of seconds to wait between redial attempts.intReserved.intReserved.intSpecifies the size, in bytes, of the RASENTRY structure.intSpecifies the number of multilink subentries associated with this entry.intSpecifies the TCP window size for all TCP sessions that run over this connection.intThe type of phone-book entry.intThe VPN strategy to use when dialing a VPN connection.The GUID (Globally Unique Identifier) that represents this phone-book entry.Specifies the IP address to be used while this connection is active.Specifies the IP address of the DNS server to be used while this connection is active.Specifies the IP address of a secondary or backup DNS server to be used while this connection is active.Specifies the IP address of the WINS server to be used while this connection is active.Specifies the IP address of a secondary WINS server to be used while this connection is active.Specifies the client's IPv6 address negotiated by the server and the client.Contains the IPv6 address of the preferred DNS.Contains the IPv6 address of the alternate DNS.char[]Specifies the area code as a null-terminated string.char[]Windows 2000 or later: This member is no longer supported.char[]Windows 2000 or later: This member is no longer supported.char[]A null-terminated string that contains the full path and file name for the dynamic link library (DLL) that implements the custom-dialing functions.char[]Contains a null-terminated string that contains the name of a TAPI device to use with this phone-book entry, for example, "XYZ Corp 28800 External".char[]Specifies a null-terminated string that indicates the RAS device type referenced by szDeviceName.char[]Pointer to a string that specifies the Domain Name Service (DNS) suffix for the connection.char[]Specifies a null-terminated device-type specific destination string.char[]Pointer to a null-terminated string that specifies a phone-book entry.char[]Pointer to a null-terminated string that specifies the full path and file name of a phone-book (PBK) file.char[]Specifies a null-terminated string that contains the name of the script file.char[]Contains a null-terminated string that identifies the X.25 address to which to connect .char[]Contains a null-terminated string that specifies the facilities to request from the X.25 host at connection.char[]Contains a null-terminated string that identifies the X.25 PAD type.char[]Contains a null-terminated string that specifies additional connection information supplied to the X.25 host at connection.Fields inherited from class com.sun.jna.StructureALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE
- 
Constructor SummaryConstructors
- 
Method SummaryMethods inherited from class com.sun.jna.StructureallocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField
- 
Field Details- 
dwSizepublic int dwSizeSpecifies the size, in bytes, of the RASENTRY structure. Before calling RasSetEntryProperties or RasGetEntryProperties, set dwSize to sizeof(RASENTRY) to identify the version of the structure.
- 
dwfOptionspublic int dwfOptionsA set of bit flags that specify connection options. Set one or more of the following flags.
- 
dwCountryIDpublic int dwCountryIDSpecifies the TAPI country/region identifier. Use the RasGetCountryInfo function to enumerate country/region identifiers. This member is ignored unless the dwfOptions member specifies the RASEO_UseCountryAndAreaCodes flag.
- 
dwCountryCodepublic int dwCountryCodeSpecifies the country/region code portion of the phone number. The country/region code must correspond to the country/region identifier specified by dwCountryID. If dwCountryCode is zero, the country/region code is based on the country/region identifier specified by dwCountryID. This member is ignored unless dwfOptions specifies the RASEO_UseCountryAndAreaCodes flag.
- 
szAreaCodepublic char[] szAreaCodeSpecifies the area code as a null-terminated string. If the dialing location does not have an area code, specify an empty string (""). Do not include parentheses or other delimiters in the area code string. For example, "206" is a valid area code; "(206)" is not. This member is ignored unless the dwfOptions member specifies the RASEO_UseCountryAndAreaCodes flag.
- 
szLocalPhoneNumberpublic char[] szLocalPhoneNumberSpecifies a null-terminated device-type specific destination string. The following table describes the contents of the szLocalPhoneNumber member for various device types.
- 
dwAlternateOffsetpublic int dwAlternateOffsetSpecifies the offset, in bytes, from the beginning of the structure to a list of consecutive null-terminated strings. The last string is terminated by two consecutive null characters. The strings are alternate phone numbers that RAS dials in the order listed if the primary number (see szLocalPhoneNumber) fails to connect. The alternate phone number strings are ANSI or Unicode, depending on whether you use the ANSI or Unicode version of the structure.
- 
ipaddrSpecifies the IP address to be used while this connection is active. This member is ignored unless dwfOptions specifies the RASEO_SpecificIpAddr flag.
- 
ipaddrDnsSpecifies the IP address of the DNS server to be used while this connection is active. This member is ignored unless dwfOptions specifies the RASEO_SpecificNameServers flag.
- 
ipaddrDnsAltSpecifies the IP address of a secondary or backup DNS server to be used while this connection is active. This member is ignored unless dwfOptions specifies the RASEO_SpecificNameServers flag.
- 
ipaddrWinsSpecifies the IP address of the WINS server to be used while this connection is active. This member is ignored unless dwfOptions specifies the RASEO_SpecificNameServers flag.
- 
ipaddrWinsAltSpecifies the IP address of a secondary WINS server to be used while this connection is active. This member is ignored unless dwfOptions specifies the RASEO_SpecificNameServers flag.
- 
dwFrameSizepublic int dwFrameSizeSpecifies the IP address of a secondary WINS server to be used while this connection is active. This member is ignored unless dwfOptions specifies the RASEO_SpecificNameServers flag.
- 
dwfNetProtocolspublic int dwfNetProtocolsSpecifies the network protocols to negotiate. This member can be a combination of the following flags.
- 
dwFramingProtocolpublic int dwFramingProtocolSpecifies the framing protocol used by the server. PPP is the emerging standard. SLIP is used mainly in UNIX environments. This member can be one of the following flags.
- 
szScriptpublic char[] szScriptSpecifies a null-terminated string that contains the name of the script file. The file name should be a full path. This field is only used for analog dial-up connections.
- 
szAutodialDllpublic char[] szAutodialDllWindows 2000 or later: This member is no longer supported. The szCustomDialDll member of the RASENTRY structure specifies the path to the custom-dial DLL. For more information on custom dialers, see RAS Custom Dialers.
- 
szAutodialFuncpublic char[] szAutodialFuncWindows 2000 or later: This member is no longer supported. See RAS Custom Dialers for more information on custom dialers.
- 
szDeviceTypepublic char[] szDeviceTypeSpecifies a null-terminated string that indicates the RAS device type referenced by szDeviceName. This member can be one of the following string constants.
- 
szDeviceNamepublic char[] szDeviceNameContains a null-terminated string that contains the name of a TAPI device to use with this phone-book entry, for example, "XYZ Corp 28800 External". To enumerate all available RAS-capable devices, use the RasEnumDevices function.
- 
szX25PadTypepublic char[] szX25PadTypeContains a null-terminated string that identifies the X.25 PAD type. Set this member to "" unless the entry should dial using an X.25 PAD. The szX25PadType string maps to a section name in PAD.INF.
- 
szX25Addresspublic char[] szX25AddressContains a null-terminated string that identifies the X.25 address to which to connect . Set this member to "" unless the entry should dial using an X.25 PAD or native X.25 device.
- 
szX25Facilitiespublic char[] szX25FacilitiesContains a null-terminated string that specifies the facilities to request from the X.25 host at connection. This member is ignored if szX25Address is an empty string ("").
- 
szX25UserDatapublic char[] szX25UserDataContains a null-terminated string that specifies additional connection information supplied to the X.25 host at connection. This member is ignored if szX25Address is an empty string ("").
- 
dwChannelspublic int dwChannelsReserved for future use
- 
dwReserved1public int dwReserved1Reserved. Must be zero.
- 
dwReserved2public int dwReserved2Reserved. Must be zero.
- 
dwSubEntriespublic int dwSubEntriesSpecifies the number of multilink subentries associated with this entry. When calling RasSetEntryProperties, set this member to zero. To add subentries to a phone-book entry, use the RasSetSubEntryProperties function.
- 
dwDialModepublic int dwDialModeSpecifies whether RAS should dial all of this entry's multilink subentries when the entry is first connected. This member can be one of the following values.
- 
dwDialExtraPercentpublic int dwDialExtraPercentSpecifies a percent of the total bandwidth available from the currently connected subentries. RAS dials an additional subentry when the total bandwidth used exceeds dwDialExtraPercent percent of the available bandwidth for at least dwDialExtraSampleSeconds seconds.
- 
dwDialExtraSampleSecondspublic int dwDialExtraSampleSecondsSpecifies the number of seconds that current bandwidth usage must exceed the threshold specified by dwDialExtraPercent before RAS dials an additional subentry.
- 
dwHangUpExtraPercentpublic int dwHangUpExtraPercentSpecifies a percent of the total bandwidth available from the currently connected subentries. RAS terminates (hangs up) an existing subentry connection when total bandwidth used is less than dwHangUpExtraPercent percent of the available bandwidth for at least dwHangUpExtraSampleSeconds seconds.
- 
dwHangUpExtraSampleSecondspublic int dwHangUpExtraSampleSecondsSpecifies the number of seconds that current bandwidth usage must be less than the threshold specified by dwHangUpExtraPercent before RAS terminates an existing subentry connection.
- 
dwIdleDisconnectSecondspublic int dwIdleDisconnectSecondsSpecifies the number of seconds after which the connection is terminated due to inactivity. Note that unless the idle time out is disabled, the entire connection is terminated if the connection is idle for the specified interval. This member can specify a number of seconds, or one of the following values.
- 
dwTypepublic int dwTypeThe type of phone-book entry. This member can be one of the following types.
- 
dwEncryptionTypepublic int dwEncryptionTypeThe type of encryption to use with the connection. The encryption is either provided by IPSec (for L2TP/IPSec connections) or by Microsoft Point-to-Point Encryption (MPPE). This member can be one of the following values.
- 
dwCustomAuthKeypublic int dwCustomAuthKeyThis member is used for Extensible Authentication Protocol (EAP). This member contains the authentication key provided to the EAP vendor.
- 
guidIdThe GUID (Globally Unique Identifier) that represents this phone-book entry. This member is read-only.
- 
szCustomDialDllpublic char[] szCustomDialDllA null-terminated string that contains the full path and file name for the dynamic link library (DLL) that implements the custom-dialing functions. This DLL should export Unicode versions of functions named RasCustomDial, RasCustomHangup, RasCustomEntryDlg, and RasCustomDialDlg. These functions should have prototypes RasCustomDialFn and RasCustomHangUpFn as defined in Ras.h, and RasCustomDialDlgFn and RasCustomEntryDlgFn as defined in Rasdlg.h.
- 
dwVpnStrategypublic int dwVpnStrategyThe VPN strategy to use when dialing a VPN connection. This member can have one of the following values.
- 
dwfOptions2public int dwfOptions2A set of bits that specify connection options. This member is a continuation of the bits specified in the dwfOptions member. Set one or more of the following bit flags.
- 
dwfOptions3public int dwfOptions3This parameter is reserved for future use.
- 
szDnsSuffixpublic char[] szDnsSuffixPointer to a string that specifies the Domain Name Service (DNS) suffix for the connection. This string can be Unicode depending on the version of the structure you are using.
- 
dwTcpWindowSizepublic int dwTcpWindowSizeSpecifies the TCP window size for all TCP sessions that run over this connection. Setting this value can increase the throughput of high-latency devices such as cellular phones.
- 
szPrerequisitePbkpublic char[] szPrerequisitePbkPointer to a null-terminated string that specifies the full path and file name of a phone-book (PBK) file. This phone-book file contains the entry specified by the szPrerequisiteEntry member. This member is used only for VPN connections.
- 
szPrerequisiteEntrypublic char[] szPrerequisiteEntryPointer to a null-terminated string that specifies a phone-book entry. This entry should exist in the phone-book file specified by the szPrerequisitePbk member. The szPrerequisteEntry member specifies an entry that RAS dials prior to establishing the connection specified by this RASENTRY structure. This member is used only for VPN connections.
- 
dwRedialCountpublic int dwRedialCountSpecifies the number of times RAS attempts to redial a connection.
- 
dwRedialPausepublic int dwRedialPauseSpecifies the number of seconds to wait between redial attempts.
- 
ipv6addrDnsContains the IPv6 address of the preferred DNS. A RASIPV6ADDR type is identical to a in6_addr structure.
- 
ipv6addrDnsAltContains the IPv6 address of the alternate DNS. A RASIPV6ADDR type is identical to a in6_addr structure.
- 
dwIPv4InterfaceMetricpublic int dwIPv4InterfaceMetricSets the metric of the IPv4 stack for this interface.
- 
dwIPv6InterfaceMetricpublic int dwIPv6InterfaceMetricSets the metric of the IPv6 stack for this interface.
- 
ipv6addrSpecifies the client's IPv6 address negotiated by the server and the client.
- 
dwIPv6PrefixLengthpublic int dwIPv6PrefixLengthThe length of the IPv6 address prefix in ipv6addr.
- 
dwNetworkOutageTimepublic int dwNetworkOutageTimeSpecifies the amount of time, in minutes, that IKEv2 packets will be retransmitted without a response before the connection is considered lost. Increase this value to support connection persistence during network outages.
 
- 
- 
Constructor Details- 
RASENTRYpublic RASENTRY()
- 
RASENTRY
 
-