Função StrComp (Visual Basic)

Artigo
08/25/2010

Retorna -1, 0 ou 1, com base no resultado de um comparação de cadeia de caracteres.

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
Obrigatório.Qualquer válido String expressão.
String2
Obrigatório.Qualquer válido String expressão.
Compare
Opcional.Especifica o tipo de comparação de strings.Se Compare é omitido, a configuração Option Compare determina o tipo de comparação.

Configurações

As configurações do argumento Compare são:

Constante	Descrição
Binary	Executa uma comparação binária, com base em uma ordem de classificar derivada das representações binárias internas dos caracteres.
Text	Executa uma comparação de texto, com base em uma ordem de classificar de texto não diferencia maiúsculas de minúsculas determinada pelas informações de cultura corrente do seu aplicativo.

Valor de retorno

The StrComp função tem os seguintes valores de retorno.

Se	StrComp retorna
String1 classificado antes de String2	-1
String1 é igual a String2	0
String1 Classifica após String2	1

Exceções

Tipo de exceção	Número de erro	Condição
ArgumentException	5	Compare o valor inválido.

Ver a coluna " número de erro " se você estiver atualizando aplicativos Visual Basic 6.0 que usam manipulação de erros não estruturada.(Você pode comparar o número do erro com a Propriedade do Número (Erro de objeto).) Entretanto, quando for possivel, você pode considerar substituir tal controle de erro por Visão Geral sobre a Manipulação Estruturada de Exceções para o Visual Basic.

Comentários

As seqüências de caracteres são comparadas por valores de classificar alfanumérica começando com o primeiro caractere.Para obter mais informações sobre binário comparações, comparações textuais e ordem de classificar, consulte Opção Comparar Declarações.

Observação de segurança:
Se seu aplicativo toma decisões de segurança com base no resultado de uma comparação ou a operação de alterar de caso, a operação deve usar o String.Compare método e passar Ordinal ou OrdinalIgnoreCase para o comparisonType argumento. Para obter mais informações, consulte Como a cultura afeta strings no Visual Basic.

Exemplo

Este exemplo usa o StrComp função para retornar os resultados de uma comparação de seqüências de caracteres. Se o terceiro argumento for omitido, o tipo de comparação definido no Option Compare os padrões de demonstrativo ou o projeto é executada.

' 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)