Método DataRecordset.GetPrimaryKey (Visio)

Obtém a configuração de chave primária e o nome de uma ou mais colunas de chaves primárias para o conjunto de registros de dados.

Sintaxe

expressão. GetPrimaryKey (PrimaryKeySettings, PrimaryKey())

Expressão Uma expressão que retorna um objeto DataRecordset .

Parâmetros

Valor de retorno

Nada

Comentários

Use o método GetPrimaryKey para determinar a configuração de chave primária existente para um conjunto de registros de dados e o nome da coluna de chave primária ou colunas se uma chave primária tiver sido especificada. O método retorna a configuração de chave primária para o conjunto de registros de dados no parâmetro de saída PrimaryKeySettings, como o valor da enumeração VisPrimaryKeySettings. O padrão (quando nenhuma chave primária é especificada) é visKeyRowOrder, que significa que o Microsoft Visio identifica as linhas do conjunto de registros de dados por ordem das linhas.

Um conjunto de registros de dados para o qual uma chave primária foi especificada pode ter colunas de chave primária única ou composta. Uma chave primária de coluna única baseia a identificação da linha nos valores de uma única coluna. Uma chave primária composta usa duas ou mais colunas para identificar exclusivamente uma linha. Os valores possíveis para PrimaryKeySettings são mostrados nesta tabela.

Para o parâmetro PrimaryKey() out, passe uma matriz sem dimensões de cadeias de caracteres. Se a configuração de chave primária retornada for visKeySingle ou visKeyComposite, o método também retornará uma matriz de cadeias de caracteres de nome de coluna de chave primária no parâmetro PrimaryKey(). Se a configuração de chave primária for visKeyRowOrder, o padrão, o método retornará uma matriz vazia.

Use o método DataRecordset.SetPrimaryKey para especificar a configuração de chave primária para o conjunto de registros de dados, bem como o nome da coluna ou colunas que você deseja definir como a coluna de chave primária ou colunas. Ao definir as chaves primárias, verifique se a(s) coluna(s) selecionada(s) como coluna(s) de chaves primárias contém(êm) valores (ou conjuntos de valores) exclusivos para cada linha.

Exemplo

Essa macro do Microsoft Visual Basic for Applications (VBA) mostra como usar o método GetPrimaryKey para determinar a configuração de chave primária, bem como o nome da primeira coluna de chaves primárias. A macro encontra o conjunto de registros de dados criado mais recentemente associado ao documento e, se uma chave primária tiver sido especificada, imprime na janela Imediata o valor da configuração da chave primária e o nome da primeira coluna de chave primária para o conjunto de registros de dados. Se não houver nenhuma chave primária, ela imprimirá a configuração de chave primária e a declaração "No primary key".

Antes de executar essa macro, crie pelo menos um conjunto de registros de dados no documento atual e, se desejar, especifique uma chave primária usando o método SetPrimaryKey .

Public Sub GetPrimaryKey_Example() 
 
    Dim vsoDataRecordset As Visio.DataRecordset 
    Dim intCount As Integer 
    Dim astrPrimaryKeyColumns() As String 
    Dim vsoKeySettings As VisPrimaryKeySettings 
 
 
    intCount = ThisDocument.DataRecordsets.Count 
    Set vsoDataRecordset = ThisDocument.DataRecordsets(intCount) 
    vsoDataRecordset.GetPrimaryKey vsoKeySettings, astrPrimaryKeyColumns 
 
    If vsoKeySettings = visKeyRowOrder Then 
        Debug.Print vsoKeySettings, "No primary key" 
    Else 
        Debug.Print vsoKeySettings, astrPrimaryKeyColumns(0) 
    End If 
    
End Sub

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.