Skip to content

cdynamicparameteraccessor-getparamstring.md

Latest commit

 

History

History
96 lines (82 loc) · 2.88 KB

cdynamicparameteraccessor-getparamstring.md

File metadata and controls

96 lines (82 loc) · 2.88 KB
Raw
title CDynamicParameterAccessor::GetParamString | Microsoft Docs
ms.custom
ms.date 11/04/2016
ms.reviewer
ms.suite
ms.technology
cpp-windows
ms.tgt_pltfrm
ms.topic article
f1_keywords
CDynamicParameterAccessor.GetParamString
GetParamString
CDynamicParameterAccessor::GetParamString
ATL.CDynamicParameterAccessor.GetParamString
ATL::CDynamicParameterAccessor::GetParamString
dev_langs
C++
helpviewer_keywords
GetParamString method
ms.assetid 078c2b1c-7072-47c1-a203-f47e75363f91
caps.latest.revision 9
author mikeblome
ms.author mblome
manager ghogen
translation.priority.ht
cs-cz
de-de
es-es
fr-fr
it-it
ja-jp
ko-kr
pl-pl
pt-br
ru-ru
tr-tr
zh-cn
zh-tw

CDynamicParameterAccessor::GetParamString

Retrieves the string data of the specified parameter stored in the buffer.

Syntax

  
      bool GetParamString(  
   DBORDINAL nParam,  
   CSimpleStringA& strOutput  
) throw( );  
bool GetParamString(  
   DBORDINAL nParam,  
   CSimpleStringW& strOutput  
) throw( );  
bool GetParamString(  
   DBORDINAL nParam,  
   CHAR* pBuffer,  
   size_t* pMaxLen  
) throw( );  
bool GetParamString(  
   DBORDINAL nParam,  
   WCHAR* pBuffer,  
   size_t* pMaxLen  
) throw( );

Parameters

nParam
[in] The parameter number (offset from 1). Parameter 0 is reserved for return values. The parameter number is the index of the parameter based on its order in the SQL or stored procedure call. See SetParam for an example.

strOutput
[out] The ANSI (CSimpleStringA) or Unicode (CSimpleStringW) string data of the specified parameter. You should pass a parameter of type CString, for example:

[!code-cppNVC_OLEDB_Consumer#9]

pBuffer
[out] A pointer to the ANSI (CHAR) or Unicode (WCHAR) string data of the specified parameter.

pMaxLen
[out] A pointer to the size of the buffer pointed to by pBuffer (in characters, including the terminating NULL).

Remarks

Returns true on success or false on failure.

If pBuffer is NULL, this method will set the required buffer size in the memory pointed to by pMaxLen and return true without copying the data.

This method will fail if the buffer pBuffer is not large enough to contain the whole string.

Use GetParamString to retrieve string parameter data from the buffer. Use GetParam to retrieve nonstring parameter data from the buffer.

Requirements

Header: atldbcli.h

See Also

CDynamicParameterAccessor Class