Получение данных неизвестной длины

Многие функции возвращают потенциально большой объем данных адресу, предоставленному приложением в качестве одного из параметров. Во всех этих случаях операция выполняется аналогично, если она не идентична. Параметр, указывающий на расположение возвращаемых данных, будет использовать соглашение о нотации, где pb или pv являются первыми двумя символами имени параметра. Другой параметр будет иметь pcb в качестве первых трех символов имени параметра. Этот параметр представляет размер (в байтах) данных, которые будут возвращены в расположение pb или pv. Например, рассмотрим следующую спецификацию функции:

#include <windows.h>

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

В этом примере pbData — это указатель на расположение, в котором будут возвращены данные, а pcbData — размер возвращаемых данных в байтах.

Примечание

Параметр-компаньон для параметра pcb иногда может содержать несколько другой префикс, например p или pv. Кроме того, для параметров-компаньонов, использующих сочетание префиксов pwsz и pcch, параметр pcch — это число символов (Юникод или ASCII, как применимо) возвращаемых данных.

 

Если буфер, заданный параметром pbData , недостаточно велик для хранения возвращаемых данных, функция задает код ERROR_MORE_DATA (который можно увидеть путем вызова функции GetLastError ) и сохраняет требуемый размер буфера в байтах в переменной, на которую указывает pcbData.

Если значение NULL является входным значением для pbData и pcbData не равно NULL, то ошибка не возвращается, а функция возвращает размер в байтах необходимого буфера памяти в переменной, на которую указывает pcbData. Это позволяет приложению определить размер и оптимальный способ выделения буфера для возвращаемых данных.

Примечание

Если значение NULL является входным значением для pbData , чтобы определить размер, необходимый для обеспечения размещения возвращаемых данных в указанном буфере, второй вызов функции, которая заполняет буфер нужными данными, может не использовать весь буфер. После второго вызова фактический размер возвращаемых данных содержится в pcbData. Используйте этот размер при обработке данных.

 

В следующем примере показано, как можно реализовать входные и выходные параметры для этой цели.

//-------------------------------------------------------------------
// 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);
}