StrComp (Función, Visual Basic)

Artículo
08/23/2008

Actualización: noviembre 2007

Devuelve un valor, -1, 0 ó 1, que indica el resultado de una comparación de cadena.

Public Shared Function StrComp( _
   ByVal String1 As String, _
   ByVal String2 As String, _
   <Microsoft.VisualBasic.OptionCompareAttribute> _
   Optional ByVal Compare As Microsoft.VisualBasic.CompareMethod _
) As Integer

Parámetros

String1
Obligatorio. Cualquier expresión String válida.
String2
Obligatorio. Cualquier expresión String válida.
Compare
Opcional. Especifica el tipo de comparación entre cadenas. Si se omite Compare, el valor Option Compare determinará el tipo de comparación.

Valores

Los valores del argumento Compare son:

Constante	Descripción
Binary	Realiza una comparación binaria basada en un tipo de ordenación que se deriva de las representaciones binarias internas de los caracteres.
Text	Realiza una comparación de texto basada en una ordenación de texto donde no se distingue entre mayúsculas y minúsculas, y que viene determinada por la información de referencia cultural actual de la aplicación.

Valor devuelto

La función StrComp devuelve los siguientes valores.

Si	StrComp devuelve
String1 se ordena delante de String2	-1
String1 es igual a String2	0
String1 se ordena después de String2	1

Excepciones

Tipo de excepción	Número de error	Condición
ArgumentException	5	El valor de Compare no es válido.

Consulte la columna "Número de error" si está actualizando aplicaciones de Visual Basic 6.0 que utilizan el control de errores no estructurado. (Se puede comparar el número de error con respecto a Number (Propiedad, objeto Err)). Sin embargo, siempre que sea posible, se debe considerar la sustitución de dicho control de errores por Información general sobre el control estructurado de excepciones de Visual Basic.

Comentarios

Las cadenas se comparan por valores alfanuméricos ordenados comenzando por el primer carácter. Para obtener más información sobre comparaciones binarias y textuales, así como criterios de ordenación, vea Option Compare (Instrucción).

Nota de seguridad:
Si la aplicación toma decisiones sobre la seguridad basándose en el resultado de una comparación o de una operación de cambio de mayúsculas y minúsculas, la operación debe utilizar el método String.Compare y pasar Ordinal o OrdinalIgnoreCase al argumento comparisonType. Para obtener más información, vea Cómo afecta la referencia cultural a las cadenas en Visual Basic.

Ejemplo

En este ejemplo se utiliza la función StrComp para devolver los resultados de una comparación de cadena. Si se omite el tercer argumento, se ejecutará el tipo de comparación definido en la instrucción Option Compare o en los valores predeterminados del proyecto.

' Defines variables.
Dim TestStr1 As String = "ABCD"
Dim TestStr2 As String = "abcd"
Dim TestComp As Integer
' The two strings sort equally. Returns 0.
TestComp = StrComp(TestStr1, TestStr2, CompareMethod.Text)
' TestStr1 sorts after TestStr2. Returns -1.
TestComp = StrComp(TestStr1, TestStr2, CompareMethod.Binary)
' TestStr2 sorts before TestStr1. Returns 1.
TestComp = StrComp(TestStr2, TestStr1)