Abrufen von Daten unbekannter Länge

Viele Funktionen geben eine potenziell große Menge an Daten an eine Adresse zurück, die als eine der Parameter der Anwendung bereitgestellt wird. In allen diesen Fällen wird der Vorgang in einer ähnlichen, sofern nicht identischen Art ausgeführt. Der Parameter, der auf den Speicherort der zurückgegebenen Daten verweist, verwendet die Notationskonvention, in der pb oder pv die ersten beiden Zeichen des Parameternamens sind. Ein weiterer Parameter verfügt über pcb als die ersten drei Zeichen des Parameternamens. Dieser Parameter stellt die Größe in Bytes der Daten dar, die an den Pb- oder Pv-Speicherort zurückgegeben werden. Berücksichtigen Sie beispielsweise die folgende Funktionsspezifikation:

#include <windows.h>

BOOL WINAPI SomeFunction(
  PCCRL_CONTEXT pCrlContext,  // in
  DWORD dwPropId,             // in
  BYTE *pbData,               // out
  DWORD *pcbData              // in/out
);

In diesem Beispiel ist pbData ein Zeiger auf den Speicherort, an dem die Daten zurückgegeben werden, und pcbData ist die Größe in Bytes der zurückgegebenen Daten.

Hinweis

Der Begleitparameter zum Pcb-Parameter kann manchmal ein etwas anderes Präfix wie p oder pv tragen. Auch für Begleitparameter mit der Kombination von Präfixen pwsz und pcch ist der Pcch-Parameter die Anzahl in Zeichen (Unicode oder ASCII, wie zutreffend), der zurückgegebenen Daten.

 

Wenn der vom pbData-Parameter angegebene Puffer nicht groß genug ist, um die zurückgegebenen Daten zu halten, legt die Funktion den ERROR_MORE_DATA Code fest (der durch Aufrufen der GetLastError-Funktion angezeigt werden kann) und speichert die erforderliche Puffergröße in Bytes in der Variablen, auf die von pcbData verwiesen wird.

Wenn NULL für pbData und pcbData nicht NULL ist, wird kein Fehler zurückgegeben, und die Funktion gibt die Größe des benötigten Speicherpuffers in der variablen zurück, die von pcbData verweist. Dadurch kann eine Anwendung die Größe der zurückgegebenen Daten bestimmen und am besten einen Puffer für die zurückgegebenen Daten zuweisen.

Hinweis

Wenn NULL für pbData eingegeben wird, um die größe zu bestimmen, die erforderlich ist, um sicherzustellen, dass die zurückgegebenen Daten in den angegebenen Puffer passen, wird der zweite Aufruf an die Funktion, die den Puffer mit den gewünschten Daten auffüllt, möglicherweise nicht den gesamten Puffer verwenden. Nach dem zweiten Aufruf ist die tatsächliche Größe der zurückgegebenen Daten in pcbData enthalten. Verwenden Sie diese Größe beim Verarbeiten der Daten.

 

Im folgenden Beispiel wird gezeigt, wie Eingabe- und Ausgabeparameter für diesen Zweck implementiert werden können.

//-------------------------------------------------------------------
// Copyright (C) Microsoft.  All rights reserved.
#include <stdio.h>
#include <windows.h>
#include <Wincrypt.h>
#define MY_ENCODING_TYPE  (PKCS_7_ASN_ENCODING | X509_ASN_ENCODING)

void MyHandleError(char *s);

void main()
{

// Set up SomeFunction variables.
PCCRL_CONTEXT pCrlContext; // Initialized elsewhere.
DWORD dwPropId;            // Initialized elsewhere.
DWORD cbData;
BYTE  *pbData;

// Call SomeFunction to set cbData, the size of 
// the buffer needed for pbData.
if(SomeFunction(
     pCrlContext, 
     dwPropId, 
     NULL, 
     &cbData))
{
       printf("The function succeeded.\n");
}
else
{

// The function call failed. Handle the error.
       MyHandleError("Function call failed.");
}

// The call succeeded; the size for the needed buffer, in bytes, 
// now resides in cbData.

// Malloc memory for the size of the message.
if(pbData = (BYTE*)malloc(cbData))
{
   printf("Memory has been allocated.\n");
}
else
{

   // The allocation failed. Write an error message and exit.
   MyHandleError("Malloc operation failed. ");
}

// The space for the buffer has been allocated.
// Call SomeFunction to fill the buffer with the data.
if(SomeFunction(
      pCrlContext, 
      dwPropId, 
      pbData, 
      &cbData))
{
       printf("The function succeeded.\n");
}
else
{

   // The second function call failed. Handle the error.
   MyHandleError("The second call to the function failed.");
}

// The function succeeded; the data is now in the buffer
// pointed to by pbData. Note that cbData is
// updated with the actual size of the data returned. Use this size 
// to process bytes of pbData.

// When you have finished using the allocated memory, free it.
free(pbData);

} // End of main

//  This example uses the function MyHandleError, a simple error
//  handling function, to print an error message to the 
//  standard error (stderr) file and exit the program. 
//  For most applications, replace this function with one 
//  that does more extensive error reporting.
void MyHandleError(char *s)
{
    fprintf(stderr,"An error occurred in running the program.\n");
    fprintf(stderr,"%s\n",s);
    fprintf(stderr,"Error number %x.\n",GetLastError());
    fprintf(stderr,"Program terminating.\n");
    exit(1);
}